AlertRestClient class

Pacote:

azure-devops-extension-api

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

Extends

RestClientBase

Construtores

AlertRestClient(IVssRestClientOptions)

Métodos

createLegalReview(string, string, number, string)	Crie uma revisão legal. Isso cria a revisão legal associada ao alerta. Ele inclui a url do item de trabalho de revisão.
getAlert(string, number, string, string, ExpandOption)	Obtenha um alerta.
getAlertInstances(string, number, string, string)	Obter instâncias de um alerta em um branch especificado com @ref. Se @ref não for fornecido, retorne instâncias de um alerta no branch padrão (se o alerta existir no branch padrão) ou no branch afetado mais recente.
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	Obter alertas para um repositório
getAlertSarif(string, number, string, string, ExpandOption)	Obtenha um alerta.
getBranches(string, string, AlertType, string, string, number, boolean)	Retorna os branches para os quais os resultados da análise foram enviados.
getOrgLevelAlertsByIds(number[])	Receba alertas por seus IDs no nível da organização. Apenas reprisa alertas que o usuário tem permissão para exibir. Retorna apenas alertas de planos sku habilitados.
getSarif(number)	Obter o status do trabalho de processamento do Sarif
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)	Obtenha os detalhes de validade de um alerta.
initiateValidation(string, string, number)	Iniciar o processo de validação para um determinado alerta
updateAlert(AlertStateUpdate, string, number, string)	Atualizar o status de um alerta
updateAlertsMetadata(AlertMetadata[], string, string)	Atualizar associações de metadados de alerta.
uploadOrgSarif(string)	Carregar um arquivo Sarif no nível da organização
uploadSarif(string, string, string, String)	Carregar um Sarif contendo alertas de segurança

Detalhes do construtor

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes do método

createLegalReview(string, string, number, string)

Crie uma revisão legal. Isso cria a revisão legal associada ao alerta. Ele inclui a url do item de trabalho de revisão.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

repository

string

Nome ou ID de um repositório para o alerta legal

alertId

number

ID de alerta de segurança avançada do alerta legal para obter a revisão legal

ref

string

Retornos

Promise<LegalReview>

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

Obtenha 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 atributos de um alerta secreto. Os valores possíveis são: None e ValidationFingerprint. Usa None como padrão. Lembre-se de que, se expand estiver definido como ValidationFingerprint, a resposta poderá conter o segredo em sua forma não criptografada. Tenha cuidado ao usar esses dados.

Retornos

Promise<Alert>

getAlertInstances(string, number, string, string)

Obter instâncias de um alerta em um branch especificado com @ref. Se @ref não for fornecido, retorne instâncias de um alerta no branch padrão (se o alerta existir no branch padrão) ou no branch afetado mais recente.

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

Promise<AlertAnalysisInstance[]>

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

Obter alertas para um repositório

function getAlerts(project: string, repository: string, top?: number, orderBy?: string, criteria?: SearchCriteria, expand?: AlertListExpandOption, 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 "severidade" Padrões para "id"

criteria

SearchCriteria

Opções para limitar os alertas retornados

expand

AlertListExpandOption

continuationToken

string

Se houver mais alertas do que pode ser retornado, 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)

Obtenha 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 atributos de um alerta secreto. Os valores possíveis são: None e ValidationFingerprint. Usa None como padrão. Lembre-se de que, se expand estiver definido como ValidationFingerprint, a resposta poderá conter o segredo em sua forma não criptografada. Tenha cuidado ao usar esses dados.

Retornos

Promise<string>

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

Retorna os branches para os quais os resultados da análise foram enviados.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

repository

string

alertType

AlertType

O tipo de alerta: Verificação de Dependência (1), Segredo (2), QL de Código (3), etc.

continuationToken

string

Uma variável de cadeia de caracteres que representa o nome do branch e é usada para buscar branches que o seguem em ordem alfabética.

branchNameContains

string

Uma variável de cadeia de caracteres usada para buscar branches que contêm essa cadeia de caracteres em qualquer lugar no nome do branch, não diferencia maiúsculas de minúsculas.

top

number

Uma variável int usada para retornar os branches k superiores que atendem aos critérios de pesquisa.

includePullRequestBranches

boolean

Uma variável bool que indica se os branches de solicitação de pull devem ou não ser incluídos.

Retornos

Promise<Branch[]>

getOrgLevelAlertsByIds(number[])

Receba alertas por seus IDs no nível da organização. Apenas reprisa alertas que o usuário tem permissão para exibir. Retorna apenas alertas de planos sku habilitados.

function getOrgLevelAlertsByIds(alertIds: number[]): Promise<Alert[]>

Parâmetros

alertIds

number[]

Lista de IDs de alerta a serem recuperadas

Retornos

Promise<Alert[]>

getSarif(number)

Obter o status do trabalho de processamento do Sarif

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

Parâmetros

sarifId

number

A ID do Sarif retornou quando o Sarif foi carregado

Retornos

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

Retornos

Promise<UxFilters>

getValidityData(string, string, number)

Obtenha os detalhes de validade de um alerta.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

repository

string

O nome ou a ID de um repositório

alertId

number

A ID do alerta

Retornos

Promise<ValidationRequestInfo>

initiateValidation(string, string, number)

Iniciar o processo de validação para um determinado alerta

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

Parâmetros

project

string

ID do projeto ou nome do projeto

repository

string

O nome ou a ID de um repositório

alertId

number

A ID do alerta

Retornos

Promise<AlertValidationRequestStatus>

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[]>

uploadOrgSarif(string)

Carregar um arquivo Sarif no nível da organização

function uploadOrgSarif(content: string): Promise<number>

Parâmetros

content

string

Conteúdo a ser carregado

Retornos

Promise<number>

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 a ser carregado

project

string

ID do projeto ou nome do projeto

repository

string

O nome ou a ID de um repositório

notificationFlag

String

Cabeçalho para sinalizar que esta é uma notificação de progresso

Retornos

Promise<number>