Alert interface

Pakiet:

azure-devops-extension-api

Właściwości

additionalInformationMessage	Dodatkowe komunikaty informacyjne do wyświetlenia dla tego alertu. W przypadku narzędzi ASAN zawiera szczegóły awarii sformatowane w blokach kodu. Dla narzędzi do skanowania kodu AI zawiera treści markdown z result.message.markdown.
additionalProperties	Dodatkowe właściwości tego alertu.
aiMetadataBlobReference	Odniesienie do metadanych AI powiązanych z alertem (tylko alerty kodu AI). Zwracał tylko na żądanie w API Get z parametrem Expand ustawionym na AIMetadataBlobReference (nie zwracany w List API).
alertId	Identyfikator alertu. Jest ona unikatowa w organizacji usługi Azure DevOps.
alertType	Typ alertu. Np. wpis tajny, kod itp.
confidence	Poziom ufności alertu.
dismissal	Zawiera informacje o odrzuceniu alertu, jeśli alert został odrzucony.
firstSeenDate	Ta wartość jest obliczana i zwracana przez usługę. Ta wartość reprezentuje pierwszy raz, gdy usługa widziała ten problem zgłoszony w wystąpieniu analizy.
fixedDate	Ta wartość jest obliczana i zwracana przez usługę. Jeśli problem został rozwiązany, ta wartość reprezentuje czas, w jaki usługa widziała ten problem rozwiązany w wystąpieniu analizy.
gitRef	Odwołanie do obiektu git, np. odwołania do gałęzi.
hasTrustedSourceOrigin	Wartość wskazuje, czy alert pochodzi z SARIF przesłanego przez zaufane źródło.
introducedDate	Ta wartość jest obliczana i zwracana przez usługę. Ta wartość reprezentuje pierwszy raz, gdy luka w zabezpieczeniach została wprowadzona.
isAutoFixable	Wartość wskazuje, czy alert może zostać automatycznie naprawiony przez Copilot autofiks. Wartość true, jeśli alert jest alertem skanowania kodu wykrytym przez bibliotekę CodeQL z obsługiwaną regułą. Wartość null, gdy wartość nie została obliczona dla tej ścieżki kodu.
isDevDependency	Wartość wskazuje, czy alert został wygenerowany dla zależności rozwojowej. True oznacza zależność od rozwoju, false oznacza zależność w czasie działania, a null oznacza nieznane lub nieprzydatne.
lastSeenDate	Ta wartość jest obliczana i zwracana przez usługę. Ta wartość reprezentuje ostatni raz, gdy usługa widziała ten problem zgłoszony w wystąpieniu analizy.
logicalLocations	Lokalizacje logiczne alertu. Ta wartość jest obliczana i zwracana przez usługę. Jest to wartość oparta na wynikach ze wszystkich konfiguracji analizy. Przykładem lokalizacji logicznej jest składnik.
physicalLocations	Ta wartość jest obliczana i zwracana przez usługę. Jest to wartość oparta na wynikach ze wszystkich konfiguracji analizy. Przykładem lokalizacji fizycznej jest lokalizacja pliku.
projectId	Identyfikator projektu, w którym wykryto alert.
relations	Relacje między alertami i innymi artefaktami.
repositoryId	Identyfikator repozytorium, w którym wykryto alert.
repositoryUrl	Adres URL repozytorium, pod którym wykryto alert.
severity	Ważność alertu.
state	Ta wartość jest obliczana i zwracana przez usługę. Jest to wartość oparta na wynikach ze wszystkich konfiguracji analizy.
title	Tytuł będzie renderowany tylko jako tekst i nie obsługuje formatowania markdown. Maksymalny limit znaków wynosi 256.
tools	Narzędzia, które wykryły ten problem.
truncatedSecret	Obcięta/zaciemniona wersja wpisu tajnego odnoszącego się do alertu (jeśli dotyczy).
validationFingerprints	ValidationFingerprints dla tajnego sprawdzania aktualności. Zwracane tylko na żądanie w obszarze Pobieranie interfejsu API z ustawionym parametrem Expand ma wartość ValidationFingerprint (nie jest zwracana w interfejsie API listy)
validityDetails	Szczegóły ważności alertu. Obecnie dotyczy to tylko alertów tajnych. W przypadku alertów wpisów tajnych stan ważności i czas są obliczane przez sprawdzenie wyników aktualności dla odcisków palców weryfikacji skojarzonych z alertem.

Szczegóły właściwości

additionalInformationMessage

Dodatkowe komunikaty informacyjne do wyświetlenia dla tego alertu. W przypadku narzędzi ASAN zawiera szczegóły awarii sformatowane w blokach kodu. Dla narzędzi do skanowania kodu AI zawiera treści markdown z result.message.markdown.

additionalInformationMessage: string

Wartość właściwości

string

additionalProperties

Dodatkowe właściwości tego alertu.

additionalProperties: {[key: string]: any}

Wartość właściwości

{[key: string]: any}

aiMetadataBlobReference

Odniesienie do metadanych AI powiązanych z alertem (tylko alerty kodu AI). Zwracał tylko na żądanie w API Get z parametrem Expand ustawionym na AIMetadataBlobReference (nie zwracany w List API).

aiMetadataBlobReference: AIMetadataBlobReference

Wartość właściwości

AIMetadataBlobReference

alertId

Identyfikator alertu. Jest ona unikatowa w organizacji usługi Azure DevOps.

alertId: number

Wartość właściwości

number

alertType

Typ alertu. Np. wpis tajny, kod itp.

alertType: AlertType

Wartość właściwości

AlertType

confidence

Poziom ufności alertu.

confidence: Confidence

Wartość właściwości

Confidence

dismissal

Zawiera informacje o odrzuceniu alertu, jeśli alert został odrzucony.

dismissal: Dismissal

Wartość właściwości

Dismissal

firstSeenDate

Ta wartość jest obliczana i zwracana przez usługę. Ta wartość reprezentuje pierwszy raz, gdy usługa widziała ten problem zgłoszony w wystąpieniu analizy.

firstSeenDate: Date

Wartość właściwości

Date

fixedDate

Ta wartość jest obliczana i zwracana przez usługę. Jeśli problem został rozwiązany, ta wartość reprezentuje czas, w jaki usługa widziała ten problem rozwiązany w wystąpieniu analizy.

fixedDate: Date

Wartość właściwości

Date

gitRef

Odwołanie do obiektu git, np. odwołania do gałęzi.

gitRef: string

Wartość właściwości

string

hasTrustedSourceOrigin

Wartość wskazuje, czy alert pochodzi z SARIF przesłanego przez zaufane źródło.

hasTrustedSourceOrigin: boolean

Wartość właściwości

boolean

introducedDate

Ta wartość jest obliczana i zwracana przez usługę. Ta wartość reprezentuje pierwszy raz, gdy luka w zabezpieczeniach została wprowadzona.

introducedDate: Date

Wartość właściwości

Date

isAutoFixable

Wartość wskazuje, czy alert może zostać automatycznie naprawiony przez Copilot autofiks. Wartość true, jeśli alert jest alertem skanowania kodu wykrytym przez bibliotekę CodeQL z obsługiwaną regułą. Wartość null, gdy wartość nie została obliczona dla tej ścieżki kodu.

isAutoFixable: boolean

Wartość właściwości

boolean

isDevDependency

Wartość wskazuje, czy alert został wygenerowany dla zależności rozwojowej. True oznacza zależność od rozwoju, false oznacza zależność w czasie działania, a null oznacza nieznane lub nieprzydatne.

isDevDependency: boolean

Wartość właściwości

boolean

lastSeenDate

Ta wartość jest obliczana i zwracana przez usługę. Ta wartość reprezentuje ostatni raz, gdy usługa widziała ten problem zgłoszony w wystąpieniu analizy.

lastSeenDate: Date

Wartość właściwości

Date

logicalLocations

Lokalizacje logiczne alertu. Ta wartość jest obliczana i zwracana przez usługę. Jest to wartość oparta na wynikach ze wszystkich konfiguracji analizy. Przykładem lokalizacji logicznej jest składnik.

logicalLocations: LogicalLocation[]

Wartość właściwości

LogicalLocation[]

physicalLocations

Ta wartość jest obliczana i zwracana przez usługę. Jest to wartość oparta na wynikach ze wszystkich konfiguracji analizy. Przykładem lokalizacji fizycznej jest lokalizacja pliku.

physicalLocations: PhysicalLocation[]

Wartość właściwości

PhysicalLocation[]

projectId

Identyfikator projektu, w którym wykryto alert.

projectId: string

Wartość właściwości

string

relations

Relacje między alertami i innymi artefaktami.

relations: RelationMetadata[]

Wartość właściwości

RelationMetadata[]

repositoryId

Identyfikator repozytorium, w którym wykryto alert.

repositoryId: string

Wartość właściwości

string

repositoryUrl

Adres URL repozytorium, pod którym wykryto alert.

repositoryUrl: string

Wartość właściwości

string

severity

Ważność alertu.

severity: Severity

Wartość właściwości

Severity

state

Ta wartość jest obliczana i zwracana przez usługę. Jest to wartość oparta na wynikach ze wszystkich konfiguracji analizy.

state: State

Wartość właściwości

State

title

Tytuł będzie renderowany tylko jako tekst i nie obsługuje formatowania markdown. Maksymalny limit znaków wynosi 256.

title: string

Wartość właściwości

string

tools

Narzędzia, które wykryły ten problem.

tools: Tool[]

Wartość właściwości

Tool[]

truncatedSecret

Obcięta/zaciemniona wersja wpisu tajnego odnoszącego się do alertu (jeśli dotyczy).

truncatedSecret: string

Wartość właściwości

string

validationFingerprints

ValidationFingerprints dla tajnego sprawdzania aktualności. Zwracane tylko na żądanie w obszarze Pobieranie interfejsu API z ustawionym parametrem Expand ma wartość ValidationFingerprint (nie jest zwracana w interfejsie API listy)

validationFingerprints: ValidationFingerprint[]

Wartość właściwości

ValidationFingerprint[]

validityDetails

Szczegóły ważności alertu. Obecnie dotyczy to tylko alertów tajnych. W przypadku alertów wpisów tajnych stan ważności i czas są obliczane przez sprawdzenie wyników aktualności dla odcisków palców weryfikacji skojarzonych z alertem.

validityDetails: AlertValidityInfo

Wartość właściwości

AlertValidityInfo