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)	Criar 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)	Receba um alerta.
getAlertInstances(string, number, string, string)	Obter instâncias de um alerta em uma ramificação especificada com @ref. Se @ref não for fornecido, retorne instâncias de um alerta na ramificação padrão (se o alerta existir na ramificação padrão) ou na ramificação afetada mais recente.
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	Obter alertas para um repositório
getAlertSarif(string, number, string, string, ExpandOption)	Receba um alerta.
getBranches(string, string, AlertType, string, string, number, boolean)	Devolve as ramificações para as quais os resultados da análise foram enviados.
getOrgLevelAlertsByIds(number[])	Receba alertas por seus IDs no nível da organização. Somente reprisa alertas que o usuário tem permissão para visualizar. Retorna apenas alertas de planos de sku habilitados.
getSarif(number)	Obter o status do trabalho de processamento 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 de 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 de Método

createLegalReview(string, string, number, string)

Criar 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 a indicação legal

alertId

number

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

ref

string

Devoluções

Promise<LegalReview>

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 os atributos de um alerta secreto. Os valores possíveis são None e ValidationFingerprint. O padrão é None. Esteja ciente de que, se expand estiver definido como ValidationFingerprint, a resposta pode conter o segredo em sua forma não criptografada. Tenha cuidado ao utilizar estes dados.

Devoluções

Promise<Alert>

getAlertInstances(string, number, string, string)

Obter instâncias de um alerta em uma ramificação especificada com @ref. Se @ref não for fornecido, retorne instâncias de um alerta na ramificação padrão (se o alerta existir na ramificação padrão) ou na ramificação afetada 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 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, 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 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

expand

AlertListExpandOption

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

Promise<PagedList<Alert>>

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 os atributos de um alerta secreto. Os valores possíveis são None e ValidationFingerprint. O padrão é None. Esteja ciente de que, se expand estiver definido como ValidationFingerprint, a resposta pode conter o segredo em sua forma não criptografada. Tenha cuidado ao utilizar estes dados.

Devoluções

Promise<string>

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

Devolve as ramificações para as 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), Código QL (3), etc.

continuationToken

string

Uma variável de cadeia de caracteres que representa o nome da ramificação e é usada para buscar ramificações que a seguem em ordem alfabética.

branchNameContains

string

Uma variável de cadeia de caracteres usada para buscar ramificações que contêm essa cadeia de caracteres em qualquer lugar no nome da ramificação, sem distinção entre maiúsculas e minúsculas.

top

number

Uma variável int usada para retornar as ramificações k superiores que satisfazem os critérios de pesquisa.

includePullRequestBranches

boolean

Uma variável bool que indica se deve ou não incluir ramificações de solicitação pull.

Devoluções

Promise<Branch[]>

getOrgLevelAlertsByIds(number[])

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

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

Parâmetros

alertIds

number[]

Lista de IDs de alerta a recuperar

Devoluções

Promise<Alert[]>

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>

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 ID de um repositório

alertId

number

O ID do alerta

Devoluções

Promise<ValidationRequestInfo>

initiateValidation(string, string, number)

Iniciar o processo de validação de 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 ID de um repositório

alertId

number

O ID do alerta

Devoluções

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

AlertMetadata[]

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

uploadOrgSarif(string)

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

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

Parâmetros

content

string

Conteúdo para carregar

Devoluções

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