Megosztás a következőn keresztül:

Instances - List

  • Referencia
Szolgáltatás:
Advanced Security
API-verzió:
7.2-preview.1

Riasztáspéldányok lekérése egy @refmegadott ágon. Ha @ref nincs megadva, az alapértelmezett ágon (ha a riasztás az alapértelmezett ágban található) vagy a legújabb érintett ágon adja vissza a riasztás példányait.

GET https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/alerts/{alertId}/instances?api-version=7.2-preview.1
Opcionális paraméterekkel: 
GET https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/alerts/{alertId}/instances?ref={ref}&api-version=7.2-preview.1

URI-paraméterek

Name In Kötelező Típus Description
alertId
 path True

integer (int64)

A lekérendő riasztás azonosítója
organization
 path True

string

Az Azure DevOps-szervezet neve.
project
 path True

string

Projektazonosító vagy projektnév
repository
 path True

string

Egy olyan adattár neve vagy azonosítója, amely a riasztás részét képezi
api-version
 query True

string

A használni kívánt API verziója. Az API ezen verziójának használatához ennek a verziónak a '7.2-preview.1' értékre kell állítania.
ref
 query

string

Válaszok

Name Típus Description
200 OK

AlertAnalysisInstance[]

sikeres művelet

Biztonság

oauth2

Típus: oauth2
Folyamat: accessCode
Engedélyezési URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Jogkivonat URL-címe: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Hatókörök

Name Description
vso.advsec Lehetővé teszi a riasztások, eredménypéldányok és elemzési eredménypéldányok olvasását

Definíciók

Name Description
AlertAnalysisInstance

Az adott elemzési konfigurációhoz tartozó riasztás állapotának összegzése.
AnalysisConfiguration

Az AnalysisConfiguration osztály builddefiníciót modell.
AnalysisConfigurationDetails
AnalysisConfigurationType

A konfiguráció típusa.
AnalysisInstance

Az AnalysisInstance osztály egy buildet modellel.
AnalysisResult
ComponentType

A függőség forrása
Dependency

Információ egy sebezhető függőségről
DependencyResult

Sebezhető függőség észlelt példánya
Result
ResultType

A riasztást kiváltó szabály típusa
Severity

A riasztás súlyossága.
State

Ezt az értéket a szolgáltatás számítja ki és adja vissza. Ez az összes elemzési konfiguráció eredményein alapuló érték.
VersionControlFilePath
VersionControlResult
VersionControlSnippet

AlertAnalysisInstance

Objektum

Az adott elemzési konfigurációhoz tartozó riasztás állapotának összegzése.

Name Típus Description
analysisConfiguration

AnalysisConfiguration

Elemzési konfiguráció.
firstSeen

AnalysisInstance

Elemzési példány, ahol a problémát először észlelték egy adott elemzési konfiguráció esetében.
fixedIn

AnalysisInstance

Elemzési példány, ahol a probléma egy adott elemzési konfigurációhoz lett javítva.
lastSeen

AnalysisInstance

Olyan elemzési példány, ahol a problémát utoljára észlelték egy adott elemzési konfiguráció esetében.
recentAnalysisInstance

AnalysisInstance

Az elemzés legutóbbi instatnce.
state

State

Adott elemzési konfiguráció eredményállapota.

AnalysisConfiguration

Objektum

Az AnalysisConfiguration osztály builddefiníciót modell.

Name Típus Description
analysisConfigurationDetails

AnalysisConfigurationDetails

A konfiguráció részletei. A kitöltött értékek a konfiguráció típusától függenek.
analysisConfigurationId

integer (int32)

Az elemzési konfiguráció azonosítója.
analysisConfigurationType

AnalysisConfigurationType

A konfiguráció típusa.
toolName

string

Az ezen a konfiguráción futtatott eszköz neve.
toolVersion

string

Az eszköz legújabb verziója, amely ezen a konfiguráción futott.

AnalysisConfigurationDetails

Objektum
Name Típus Description
additionalProperties

object

A folyamat tulajdonságai.
gitRef

string

Hivatkozás egy git-objektumra, például ág-ref.
isDefaultBranch

boolean

Ez az alapértelmezett ág?
phaseId

string (uuid)

A folyamat fázisazonosítója.
phaseName

string

Fázis neve.
pipelineId

integer (int32)

AzureDevOps-folyamat azonosítója.
pipelineName

string

A folyamat neve.

AnalysisConfigurationType

Enumerálás

A konfiguráció típusa.

Érték Description
adoPipeline

Az Ado Pipeline ágat, folyamatot, fázist és ADOPipelineId azonosítót tartalmaz
default

Alapértelmezett elemzési konfiguráció, amely nincs más konfigurációs adatokhoz csatolva

AnalysisInstance

Objektum

Az AnalysisInstance osztály egy buildet modellel.

Name Típus Description
commitId

string

A CommitId az adott példány véglegesítési azonosítója
configuration

AnalysisConfiguration

Elemzési konfiguráció.
createdDate

string (date-time)

Az elemzés létrehozásának dátuma.
instanceIdentifier

string

Az InstanceIdentifier egy kulcs, amely egyedileg hozza létre ezt a példányt
results

AnalysisResult[]

Az elemzés által jelentett eredmények.
url

string

Az URL a build permalinkja.

AnalysisResult

Objektum
Name Típus Description
analysisResultId

integer (int64)

firstIntroducedInstanceId

integer (int32)

fixedInstanceId

integer (int32)

introducedInstanceId

integer (int32)

lastSeenInstanceId

integer (int32)

result

Result

state

State

ComponentType

Enumerálás

A függőség forrása

Érték Description
cargo

Azt jelzi, hogy az összetevő egy rakománycsomag.
conda

Azt jelzi, hogy az összetevő egy Conda-csomag.
dockerImage

Azt jelzi, hogy az összetevő egy Docker-rendszerkép
dockerReference

Azt jelzi, hogy az összetevő egy Docker-referencia.
file

Azt jelzi, hogy az összetevő egy laza fájl. Nem a különböző csomagkezelők által értelmezett csomag.
git

Azt jelzi, hogy az összetevő egy Git-adattár.
go

Azt jelzi, hogy az összetevő go csomag.
linux

Azt jelzi, hogy az összetevő linuxos környezetben található. Linux-alapú csomagkezelők által ismert csomag, mint az apt és az rpm.
maven

Azt jelzi, hogy az összetevő egy Maven-összetevő.
npm

Azt jelzi, hogy az összetevő egy Npm-csomag.
nuGet
other

Azt jelzi, hogy az összetevő nem tartozik az irányítás által támogatott összetevők egyikéhez sem.
pip

Azt jelzi, hogy az összetevő egy Pip-csomag.
pod

Azt jelzi, hogy az összetevő egy CocoaPods pod.
rubyGems

Azt jelzi, hogy az összetevő egy Ruby gem.
unknown
vcpkg

Azt jelzi, hogy az összetevő egy Vcpkg-csomag.

Dependency

Objektum

Információ egy sebezhető függőségről

Name Típus Description
componentName

string

Függőség neve
componentType

ComponentType

A függőség forrása
componentVersion

string

Verzióinformációk
dependencyId

integer (int32)

A függőség egyedi azonosítója

DependencyResult

Objektum

Sebezhető függőség észlelt példánya

Name Típus Description
dependency

Dependency

A talált sebezhető függőségre vonatkozó információk
dependencyResultId

integer (int32)

A függőség egyedi azonosítója
resultId

integer (int32)

Annak az eredménynek az azonosítója, amelyhez ez a példány tartozik
rootDependencyId

integer (int32)

Heirarchális információk több példány megtalálásakor
versionControlFilePath

VersionControlFilePath

Információ arról, hogy hol található a függőség

Result

Objektum
Name Típus Description
dependencyResult

DependencyResult

További információ a riasztásról. Érvényes, ha a ResultType függőség
fingerprint

string

Az eredmény teljes ujjlenyomata. Ez ugyanazon riasztás duplikált példányainak észlelésére szolgál
fingerprintId

integer (int64)

Az eredmény ujjlenyomatának egyedi azonosítója
resultId

integer (int32)

Az eredmény egyedi azonosítója
resultMessage

string

A riasztást kiváltó szabály részletes leírása
resultType

ResultType

A riasztást kiváltó szabály típusa
ruleId

integer (int32)

A riasztást aktiváló szabály azonosítója
ruleShortDescription

string

A riasztást kiváltó szabály rövid leírása
severity

Severity

A riasztás súlyossága
versionControlResult

VersionControlResult

További információ a riasztásról. Érvényes, ha a ResultType a VersionControl

ResultType

Enumerálás

A riasztást kiváltó szabály típusa

Érték Description
dependency

Az eredmény függőségelemzésből származik
unknown

Az eredmény meghatározatlan elemzési típusból származik
versionControl

Az eredmény statikus kódelemzésből származik

Severity

Enumerálás

A riasztás súlyossága.

Érték Description
critical
error
high
low
medium
note
undefined
warning

State

Enumerálás

Ezt az értéket a szolgáltatás számítja ki és adja vissza. Ez az összes elemzési konfiguráció eredményein alapuló érték.

Érték Description
active

Riasztást észlelt a kód
autoDismissed

Az eszköz megállapította, hogy a probléma már nem jelent kockázatot
dismissed

A riasztást egy felhasználó elutasította
fixed

A probléma már nem észlelhető a kódban
unknown

A riasztás határozatlan állapotban van

VersionControlFilePath

Objektum
Name Típus Description
filePath

string

A fájl elérési útja a verziókövetési rendszerben
filePathHash

string[] (byte)

A fájl kivonata a verziókövetési rendszerben
versionControlFilePathId

integer (int64)

A fájl egyedi azonosítója a verziókövetési rendszerben

VersionControlResult

Objektum
Name Típus Description
resultId

integer (int32)

A struktúra társítsa a koopatiás eredményhez társítandó azonosítót
versionControlSnippet

VersionControlSnippet

Információ az eredmény helyét tartalmazó kódrészletről

VersionControlSnippet

Objektum
Name Típus Description
endColumn

integer (int32)

oszlopot a kódfájlban, ahol a kódrészlet véget ér
endLine

integer (int32)

sor a kódfájlban, ahol a kódrészlet véget ér
startColumn

integer (int32)

oszlop a kódfájlban, ahol a kódrészlet elindul
startLine

integer (int32)

a kódfájl azon sorában, ahol a kódrészlet elindul
versionControlFilePath

VersionControlFilePath

a kódfájl elérési útja a verziókövetési rendszerben
versionControlFilePathId

integer (int64)

A fájl elérési útjának egyedi azonosítószáma
versionControlSnippetId

integer (int64)

A kódrészlet egyedi azonosítószáma