Alert interface

Pacote:

azure-devops-extension-api

Propriedades

additionalInformationMessage	Mensagem de informação adicional a mostrar para este alerta. Para ferramentas ASAN, contém detalhes de falhas formatados em blocos de código. Para ferramentas de análise de código por IA, contém conteúdo markdown proveniente do result.message.markdown.
additionalProperties	Propriedades adicionais deste alerta.
aiMetadataBlobReference	Referência ao blob de metadados de IA associado ao alerta (apenas alertas de código de IA). Apenas devolvido a pedido na Get API com o parâmetro Expand definido como AIMetadataBlobReference (não devolvido na List API).
alertId	Identificador do alerta. Ele é exclusivo dentro da organização do Azure DevOps.
alertType	Tipo de alerta. Por exemplo, segredo, código, etc.
confidence	Nível de confiança do alerta.
dismissal	Contém informações para a rejeição do alerta se este tiver sido indeferido.
firstSeenDate	Esse valor é calculado e retornado pelo serviço. Esse valor representa a primeira vez que o serviço vê esse problema relatado em uma instância de análise.
fixedDate	Esse valor é calculado e retornado pelo serviço. Se o problema for corrigido, esse valor representa o tempo que o serviço viu esse problema corrigido em uma instância de análise.
gitRef	Referência a um objeto git, por exemplo, branch ref.
hasTrustedSourceOrigin	Valor indica se o alerta provém de um SARIF carregado por uma fonte de confiança.
introducedDate	Esse valor é calculado e retornado pelo serviço. Este valor representa a primeira vez que a vulnerabilidade foi introduzida.
isAutoFixable	O valor indica se o alerta pode ser corrigido automaticamente pelo Copilot Autofix. É verdade quando o alerta é um alerta de varredura de código detetado pelo CodeQL com uma regra suportada. Nulo quando o valor não foi calculado para este caminho de código.
isDevDependency	Valor indica se o alerta foi gerado para uma dependência de desenvolvimento. Verdadeiro indica dependência de desenvolvimento, falso indica dependência em tempo de execução, e nulo indica desconhecido ou não aplicável.
lastSeenDate	Esse valor é calculado e retornado pelo serviço. Esse valor representa a última vez que o serviço viu esse problema relatado em uma instância de análise.
logicalLocations	Locais lógicos para o alerta. Esse valor é calculado e retornado pelo serviço. É um valor baseado nos resultados de todas as configurações de análise. Um exemplo de um local lógico é um componente.
physicalLocations	Esse valor é calculado e retornado pelo serviço. É um valor baseado nos resultados de todas as configurações de análise. Um exemplo de um local físico é um local de arquivo.
projectId	Identificador do projeto onde o alerta foi detetado.
relations	Relações entre alertas e outros artefactos.
repositoryId	Identificador do repositório onde o alerta foi detetado.
repositoryUrl	URL do repositório onde o alerta foi detetado.
severity	Severidade do alerta.
state	Esse valor é calculado e retornado pelo serviço. É um valor baseado nos resultados de todas as configurações de análise.
title	O título só será renderizado como texto e não suporta formatação de marcação. Há um limite máximo de caracteres de 256.
tools	Ferramentas que detetaram esse problema.
truncatedSecret	Uma versão truncada/ofuscada do segredo relativo à indicação (se aplicável).
validationFingerprints	ValidaçãoImpressões digitais para a verificação de vivacidade secreta. Somente retornado sob demanda em Get API com o parâmetro Expand definido como ValidationFingerprint (não retornado em List API)
validityDetails	Detalhes de validade de um alerta. Atualmente, isso só é aplicável a alertas secretos. No caso de alertas secretos, o estado de validade e o tempo são calculados através da observação dos resultados de vivacidade para validação das impressões digitais associadas a um alerta.

Detalhes de Propriedade

additionalInformationMessage

Mensagem de informação adicional a mostrar para este alerta. Para ferramentas ASAN, contém detalhes de falhas formatados em blocos de código. Para ferramentas de análise de código por IA, contém conteúdo markdown proveniente do result.message.markdown.

additionalInformationMessage: string

Valor de Propriedade

string

additionalProperties

Propriedades adicionais deste alerta.

additionalProperties: {[key: string]: any}

Valor de Propriedade

{[key: string]: any}

aiMetadataBlobReference

Referência ao blob de metadados de IA associado ao alerta (apenas alertas de código de IA). Apenas devolvido a pedido na Get API com o parâmetro Expand definido como AIMetadataBlobReference (não devolvido na List API).

aiMetadataBlobReference: AIMetadataBlobReference

Valor de Propriedade

AIMetadataBlobReference

alertId

Identificador do alerta. Ele é exclusivo dentro da organização do Azure DevOps.

alertId: number

Valor de Propriedade

number

alertType

Tipo de alerta. Por exemplo, segredo, código, etc.

alertType: AlertType

Valor de Propriedade

AlertType

confidence

Nível de confiança do alerta.

confidence: Confidence

Valor de Propriedade

Confidence

dismissal

Contém informações para a rejeição do alerta se este tiver sido indeferido.

dismissal: Dismissal

Valor de Propriedade

Dismissal

firstSeenDate

Esse valor é calculado e retornado pelo serviço. Esse valor representa a primeira vez que o serviço vê esse problema relatado em uma instância de análise.

firstSeenDate: Date

Valor de Propriedade

Date

fixedDate

Esse valor é calculado e retornado pelo serviço. Se o problema for corrigido, esse valor representa o tempo que o serviço viu esse problema corrigido em uma instância de análise.

fixedDate: Date

Valor de Propriedade

Date

gitRef

Referência a um objeto git, por exemplo, branch ref.

gitRef: string

Valor de Propriedade

string

hasTrustedSourceOrigin

Valor indica se o alerta provém de um SARIF carregado por uma fonte de confiança.

hasTrustedSourceOrigin: boolean

Valor de Propriedade

boolean

introducedDate

Esse valor é calculado e retornado pelo serviço. Este valor representa a primeira vez que a vulnerabilidade foi introduzida.

introducedDate: Date

Valor de Propriedade

Date

isAutoFixable

O valor indica se o alerta pode ser corrigido automaticamente pelo Copilot Autofix. É verdade quando o alerta é um alerta de varredura de código detetado pelo CodeQL com uma regra suportada. Nulo quando o valor não foi calculado para este caminho de código.

isAutoFixable: boolean

Valor de Propriedade

boolean

isDevDependency

Valor indica se o alerta foi gerado para uma dependência de desenvolvimento. Verdadeiro indica dependência de desenvolvimento, falso indica dependência em tempo de execução, e nulo indica desconhecido ou não aplicável.

isDevDependency: boolean

Valor de Propriedade

boolean

lastSeenDate

Esse valor é calculado e retornado pelo serviço. Esse valor representa a última vez que o serviço viu esse problema relatado em uma instância de análise.

lastSeenDate: Date

Valor de Propriedade

Date

logicalLocations

Locais lógicos para o alerta. Esse valor é calculado e retornado pelo serviço. É um valor baseado nos resultados de todas as configurações de análise. Um exemplo de um local lógico é um componente.

logicalLocations: LogicalLocation[]

Valor de Propriedade

LogicalLocation[]

physicalLocations

Esse valor é calculado e retornado pelo serviço. É um valor baseado nos resultados de todas as configurações de análise. Um exemplo de um local físico é um local de arquivo.

physicalLocations: PhysicalLocation[]

Valor de Propriedade

PhysicalLocation[]

projectId

Identificador do projeto onde o alerta foi detetado.

projectId: string

Valor de Propriedade

string

relations

Relações entre alertas e outros artefactos.

relations: RelationMetadata[]

Valor de Propriedade

RelationMetadata[]

repositoryId

Identificador do repositório onde o alerta foi detetado.

repositoryId: string

Valor de Propriedade

string

repositoryUrl

URL do repositório onde o alerta foi detetado.

repositoryUrl: string

Valor de Propriedade

string

severity

Severidade do alerta.

severity: Severity

Valor de Propriedade

Severity

state

Esse valor é calculado e retornado pelo serviço. É um valor baseado nos resultados de todas as configurações de análise.

state: State

Valor de Propriedade

State

title

O título só será renderizado como texto e não suporta formatação de marcação. Há um limite máximo de caracteres de 256.

title: string

Valor de Propriedade

string

tools

Ferramentas que detetaram esse problema.

tools: Tool[]

Valor de Propriedade

Tool[]

truncatedSecret

Uma versão truncada/ofuscada do segredo relativo à indicação (se aplicável).

truncatedSecret: string

Valor de Propriedade

string

validationFingerprints

ValidaçãoImpressões digitais para a verificação de vivacidade secreta. Somente retornado sob demanda em Get API com o parâmetro Expand definido como ValidationFingerprint (não retornado em List API)

validationFingerprints: ValidationFingerprint[]

Valor de Propriedade

ValidationFingerprint[]

validityDetails

Detalhes de validade de um alerta. Atualmente, isso só é aplicável a alertas secretos. No caso de alertas secretos, o estado de validade e o tempo são calculados através da observação dos resultados de vivacidade para validação das impressões digitais associadas a um alerta.

validityDetails: AlertValidityInfo

Valor de Propriedade

AlertValidityInfo