Alert interface

套件:

azure-devops-extension-api

屬性

additionalInformationMessage	此警示需顯示額外資訊訊息。 ASAN 工具則包含以程式碼區塊格式化的當機細節。 針對 AI 程式碼掃描工具，包含來自 result.message.markdown 的 markdown 內容。
additionalProperties	此警示的其他屬性。
aiMetadataBlobReference	參考與警示相關的 AI 元資料塊（僅限 AI 程式碼警示）。 只有當 Expand 參數設為 AIMetadataBlobReference 時，才會隨需回傳。
alertId	警示的標識碼。 它在 Azure DevOps 組織中是唯一的。
alertType	警示的類型。 例如秘密、程序代碼等。
confidence	警示的信賴等級。
dismissal	如果警示已關閉，則包含警示關閉的資訊。
firstSeenDate	這個值是由服務計算和傳回。 此值表示服務第一次在分析實例中回報此問題。
fixedDate	這個值是由服務計算和傳回。 如果問題已修正，這個值表示服務在分析實例中已修正此問題的時間。
gitRef	git 對象的參考，例如分支參考。
hasTrustedSourceOrigin	值表示警示是否來自可信來源上傳的 SARIF。
introducedDate	這個值是由服務計算和傳回。 此值表示第一次引進弱點。
isAutoFixable	值表示 Copilot Autofix 目前是否能在警報中執行。 當組織可用且在倉庫啟用 Copilot Autofix 時，該警示即為 CodeQL 偵測到的程式碼掃描警示，且符合支援規則，且警示的參考文獻符合資格。 當該代碼路徑的值尚未計算時，為空。
isDevDependency	值表示該警示是否為開發依賴產生。 True 表示開發依賴性，false 表示執行時依賴性，null 表示未知或不適用。
lastSeenDate	這個值是由服務計算和傳回。 此值代表服務在分析實例中回報此問題的最後一次。
logicalLocations	警示的邏輯位置。 這個值是由服務計算和傳回。 它是以所有分析組態的結果為基礎的值。 邏輯位置的範例是元件。
physicalLocations	這個值是由服務計算和傳回。 它是以所有分析組態的結果為基礎的值。 實體位置的範例是檔案位置。
projectId	偵測到警示的專案識別碼。
relations	警示與其他成品之間的關係。
repositoryId	偵測到警示的儲存庫識別碼。
repositoryUrl	偵測到警示的存放庫 URL。
severity	警示的嚴重性。
state	這個值是由服務計算和傳回。 它是以所有分析組態的結果為基礎的值。
title	標題只會轉譯為文字，且不支援 Markdown 格式設定。 字元上限為 512 字。
tools	偵測到此問題的工具。
truncatedSecret	與警示相關的秘密截斷/模糊化版本（如果適用的話）。
validationFingerprints	秘密活躍度檢查的 ValidationFingerprints。 只有在 Get API 中視需要傳回 Expand 參數設為 ValidationFingerprint （未在清單 API 中傳回）
validityDetails	警示的有效性詳細數據。 目前，這隻適用於秘密警示。 如果是秘密警示，則會藉由查看與警示相關聯之驗證指紋的活躍度結果，來計算有效狀態和時間。

屬性詳細資料

additionalInformationMessage

此警示需顯示額外資訊訊息。 ASAN 工具則包含以程式碼區塊格式化的當機細節。 針對 AI 程式碼掃描工具，包含來自 result.message.markdown 的 markdown 內容。

additionalInformationMessage: string

屬性值

string

additionalProperties

此警示的其他屬性。

additionalProperties: {[key: string]: any}

屬性值

{[key: string]: any}

aiMetadataBlobReference

參考與警示相關的 AI 元資料塊（僅限 AI 程式碼警示）。 只有當 Expand 參數設為 AIMetadataBlobReference 時，才會隨需回傳。

aiMetadataBlobReference: AIMetadataBlobReference

屬性值

AIMetadataBlobReference

alertId

警示的標識碼。 它在 Azure DevOps 組織中是唯一的。

alertId: number

屬性值

number

alertType

警示的類型。 例如秘密、程序代碼等。

alertType: AlertType

屬性值

AlertType

confidence

警示的信賴等級。

confidence: Confidence

屬性值

Confidence

dismissal

如果警示已關閉，則包含警示關閉的資訊。

dismissal: Dismissal

屬性值

Dismissal

firstSeenDate

這個值是由服務計算和傳回。 此值表示服務第一次在分析實例中回報此問題。

firstSeenDate: Date

屬性值

Date

fixedDate

這個值是由服務計算和傳回。 如果問題已修正，這個值表示服務在分析實例中已修正此問題的時間。

fixedDate: Date

屬性值

Date

gitRef

git 對象的參考，例如分支參考。

gitRef: string

屬性值

string

hasTrustedSourceOrigin

值表示警示是否來自可信來源上傳的 SARIF。

hasTrustedSourceOrigin: boolean

屬性值

boolean

introducedDate

這個值是由服務計算和傳回。 此值表示第一次引進弱點。

introducedDate: Date

屬性值

Date

isAutoFixable

值表示 Copilot Autofix 目前是否能在警報中執行。 當組織可用且在倉庫啟用 Copilot Autofix 時，該警示即為 CodeQL 偵測到的程式碼掃描警示，且符合支援規則，且警示的參考文獻符合資格。 當該代碼路徑的值尚未計算時，為空。

isAutoFixable: boolean

屬性值

boolean

isDevDependency

值表示該警示是否為開發依賴產生。 True 表示開發依賴性，false 表示執行時依賴性，null 表示未知或不適用。

isDevDependency: boolean

屬性值

boolean

lastSeenDate

這個值是由服務計算和傳回。 此值代表服務在分析實例中回報此問題的最後一次。

lastSeenDate: Date

屬性值

Date

logicalLocations

警示的邏輯位置。 這個值是由服務計算和傳回。 它是以所有分析組態的結果為基礎的值。 邏輯位置的範例是元件。

logicalLocations: LogicalLocation[]

屬性值

LogicalLocation[]

physicalLocations

這個值是由服務計算和傳回。 它是以所有分析組態的結果為基礎的值。 實體位置的範例是檔案位置。

physicalLocations: PhysicalLocation[]

屬性值

PhysicalLocation[]

projectId

偵測到警示的專案識別碼。

projectId: string

屬性值

string

relations

警示與其他成品之間的關係。

relations: RelationMetadata[]

屬性值

RelationMetadata[]

repositoryId

偵測到警示的儲存庫識別碼。

repositoryId: string

屬性值

string

repositoryUrl

偵測到警示的存放庫 URL。

repositoryUrl: string

屬性值

string

severity

警示的嚴重性。

severity: Severity

屬性值

Severity

state

這個值是由服務計算和傳回。 它是以所有分析組態的結果為基礎的值。

state: State

屬性值

State

title

標題只會轉譯為文字，且不支援 Markdown 格式設定。 字元上限為 512 字。

title: string

屬性值

string

tools

偵測到此問題的工具。

tools: Tool[]

屬性值

Tool[]

truncatedSecret

與警示相關的秘密截斷/模糊化版本（如果適用的話）。

truncatedSecret: string

屬性值

string

validationFingerprints

秘密活躍度檢查的 ValidationFingerprints。 只有在 Get API 中視需要傳回 Expand 參數設為 ValidationFingerprint （未在清單 API 中傳回）

validationFingerprints: ValidationFingerprint[]

屬性值

ValidationFingerprint[]

validityDetails

警示的有效性詳細數據。 目前，這隻適用於秘密警示。 如果是秘密警示，則會藉由查看與警示相關聯之驗證指紋的活躍度結果，來計算有效狀態和時間。

validityDetails: AlertValidityInfo

屬性值

AlertValidityInfo