SearchCriteria interface

Balíček:

azure-devops-extension-api

Vlastnosti

alertIds	Pokud je k dispozici, vrátí se pouze výstrahy se zadanými ID. <br />V opačném případě vraťte všechny výstrahy.
alertType	Pokud je k dispozici, vrátí se pouze výstrahy tohoto typu. V opačném případě vrátí výstrahy všech typů.
confidenceLevels	Pokud je tato výstraha za předpokladu poskytnuta, vraťte výstrahy pouze na těchto úrovních spolehlivosti. <Pro načtení výstrah všech úrovní spolehlivosti je potřeba zadat br />High i Other. <br />Otherwise, vrátit výstrahy s vysokou úrovní spolehlivosti. <br />Platí pouze pro tajné výstrahy.
dependencyName	V případě potřeby se vrátí pouze výstrahy pro tuto závislost. <br />Jinak vrátí výstrahy pro všechny závislosti. <br />Při odeslání sarif je ve výsledku zadána závislost (nebo komponenta). RelatedLocations[].logicalLocation. <br />Nelze použít pro výstrahy tajných kódů.
fromDate	Pokud je k dispozici, vrátí se pouze výstrahy, které byly naposledy zobrazeny po tomto datu. <br />Jinak vrátit všechna upozornění.
hasLinkedWorkItems	Pokud je k dispozici, filtruje výstrahy na základě toho, jestli mají propojené pracovní položky. <BR />Nastaveno na "true" pro vrácení pouze upozornění s propojenými pracovními položkami. <BR />Nastaveno na "falešné", aby se vracely pouze upozornění bez propojených pracovních položek. <BR />Pokud není poskytnuto, vrací všechna upozornění bez ohledu na propojené pracovní položky. <Br />Neplatí pro upozornění na skenování tajných a závislostí.
keywords	Pokud je k dispozici, vraťte pouze výstrahy, jejichž názvy odpovídají tomuto vzoru.
licenseName	V případě potřeby se vrátí pouze výstrahy vytvořené pro závislost s touto licencí. <br />Jinak vrátí upozornění pro všechny licence. <br />Ve sarif odeslání je ve výsledku zadána licence pro závislost (nebo komponentu). RelatedLocations[].logicalLocation.properties.license. <br />Nelze použít pro výstrahy tajných kódů.
modifiedSince	Pokud je k dispozici, vraťte pouze upozornění, která byla od tohoto data změněna. <br />Jinak vrátit všechna upozornění.
onlyDefaultBranch	Pokud je hodnota true nebo není nastavená, vrátí pouze výstrahy nalezené ve výchozí větvi úložiště. <br />Pokud ve výchozí větvi nebyly dokončena žádná spuštění, použije se místo toho poslední spuštění bez ohledu na větev použitou pro toto spuštění. Pokud je false, vraťte výstrahy ze všech větví. <br />Tato možnost je ignorována, pokud je k dispozici odkaz. <br />Nelze použít pro výstrahy tajných kódů.
phaseId	Pokud je k dispozici s pipelineName, vrátí pouze výstrahy zjištěné v této fázi kanálu <br />Jinak vrátit výstrahy zjištěné ve všech fázích. <br />Nelze použít pro výstrahy tajných kódů.
phaseName	Pokud je k dispozici s pipelineName, vrátí pouze výstrahy zjištěné v této fázi kanálu <br />Jinak vrátit výstrahy zjištěné ve všech fázích. <br />Nelze použít pro výstrahy tajných kódů.
pipelineName	Pokud je k dispozici, vrátí se v tomto kanálu pouze výstrahy. <br />Jinak vrátí výstrahy zjištěné ve všech kanálech. <br />Nelze použít pro výstrahy tajných kódů.
ref	Pokud je k dispozici, uveďte pouze výstrahy pro tuto referenční hodnotu. <br />Pokud není k dispozici a onlyDefaultBranch je true, uveďte pouze výstrahy nalezené ve výchozí větvi nebo poslední větvi spuštění, pokud pro výchozí větev neexistuje žádná konfigurace analýzy. <br />Jinak uveďte výstrahy ze všech větví. <br />Nelze použít pro výstrahy tajných kódů.
ruleId	Pokud je toto pravidlo k dispozici, vraťte pouze výstrahy. <br />Jinak vrátí upozornění všech pravidel.
ruleName	Pokud je toto pravidlo k dispozici, vraťte pouze výstrahy. <br />Jinak vrátí upozornění pro všechna pravidla.
severities	Pokud je tato výstraha za předpokladu poskytnuta, vraťte výstrahy pouze v těchto závažnostech. <br />Otherwise, vrátit výstrahy v jakékoli závažnosti.
states	Pokud je tato výstraha za předpokladu poskytnuta, vraťte pouze výstrahy v těchto stavech. <br />Jinak vrátí výstrahy v libovolném stavu.
toDate	Pokud je k dispozici, vrátí se pouze výstrahy, které se naposledy zobrazily před tímto datem. <br />Jinak vrátit všechna upozornění.
toolName	Pokud je nástroj toolName k dispozici, vrátí pouze výstrahy zjištěné tímto nástrojem. <br />Jinak vrátí výstrahy zjištěné všemi nástroji.
validity	Pokud je tato možnost zadaná, vraťte pouze výstrahy s platností uvedenou zde. Pokud je stav platnosti Neznámý, načtěte upozornění na všechny výsledky platnosti. <br />Platí pouze pro tajné výstrahy. <br />Filtrování podle stavu platnosti může způsobit, že bude vráceno méně výstrah, než je požadováno s parametrem TOP. <br />Kvůli tomuto chování se vlastnost ContinuationToken(<![ CDATA[<název> hlavičky]]>) v hlavičce odpovědi by se mělo spoléhat na rozhodnutí, jestli je potřeba načíst další dávku.

Podrobnosti vlastnosti

alertIds

Pokud je k dispozici, vrátí se pouze výstrahy se zadanými ID. <br />V opačném případě vraťte všechny výstrahy.

alertIds: number[]

Hodnota vlastnosti

number[]

alertType

Pokud je k dispozici, vrátí se pouze výstrahy tohoto typu. V opačném případě vrátí výstrahy všech typů.

alertType: AlertType

Hodnota vlastnosti

AlertType

confidenceLevels

Pokud je tato výstraha za předpokladu poskytnuta, vraťte výstrahy pouze na těchto úrovních spolehlivosti. <Pro načtení výstrah všech úrovní spolehlivosti je potřeba zadat br />High i Other. <br />Otherwise, vrátit výstrahy s vysokou úrovní spolehlivosti. <br />Platí pouze pro tajné výstrahy.

confidenceLevels: Confidence[]

Hodnota vlastnosti

Confidence[]

dependencyName

V případě potřeby se vrátí pouze výstrahy pro tuto závislost. <br />Jinak vrátí výstrahy pro všechny závislosti. <br />Při odeslání sarif je ve výsledku zadána závislost (nebo komponenta). RelatedLocations[].logicalLocation. <br />Nelze použít pro výstrahy tajných kódů.

dependencyName: string

Hodnota vlastnosti

string

fromDate

Pokud je k dispozici, vrátí se pouze výstrahy, které byly naposledy zobrazeny po tomto datu. <br />Jinak vrátit všechna upozornění.

fromDate: Date

Hodnota vlastnosti

Date

hasLinkedWorkItems

Pokud je k dispozici, filtruje výstrahy na základě toho, jestli mají propojené pracovní položky. <BR />Nastaveno na "true" pro vrácení pouze upozornění s propojenými pracovními položkami. <BR />Nastaveno na "falešné", aby se vracely pouze upozornění bez propojených pracovních položek. <BR />Pokud není poskytnuto, vrací všechna upozornění bez ohledu na propojené pracovní položky. <Br />Neplatí pro upozornění na skenování tajných a závislostí.

hasLinkedWorkItems: boolean

Hodnota vlastnosti

boolean

keywords

Pokud je k dispozici, vraťte pouze výstrahy, jejichž názvy odpovídají tomuto vzoru.

keywords: string

Hodnota vlastnosti

string

licenseName

V případě potřeby se vrátí pouze výstrahy vytvořené pro závislost s touto licencí. <br />Jinak vrátí upozornění pro všechny licence. <br />Ve sarif odeslání je ve výsledku zadána licence pro závislost (nebo komponentu). RelatedLocations[].logicalLocation.properties.license. <br />Nelze použít pro výstrahy tajných kódů.

licenseName: string

Hodnota vlastnosti

string

modifiedSince

Pokud je k dispozici, vraťte pouze upozornění, která byla od tohoto data změněna. <br />Jinak vrátit všechna upozornění.

modifiedSince: Date

Hodnota vlastnosti

Date

onlyDefaultBranch

Pokud je hodnota true nebo není nastavená, vrátí pouze výstrahy nalezené ve výchozí větvi úložiště. <br />Pokud ve výchozí větvi nebyly dokončena žádná spuštění, použije se místo toho poslední spuštění bez ohledu na větev použitou pro toto spuštění. Pokud je false, vraťte výstrahy ze všech větví. <br />Tato možnost je ignorována, pokud je k dispozici odkaz. <br />Nelze použít pro výstrahy tajných kódů.

onlyDefaultBranch: boolean

Hodnota vlastnosti

boolean

phaseId

Pokud je k dispozici s pipelineName, vrátí pouze výstrahy zjištěné v této fázi kanálu <br />Jinak vrátit výstrahy zjištěné ve všech fázích. <br />Nelze použít pro výstrahy tajných kódů.

phaseId: string

Hodnota vlastnosti

string

phaseName

Pokud je k dispozici s pipelineName, vrátí pouze výstrahy zjištěné v této fázi kanálu <br />Jinak vrátit výstrahy zjištěné ve všech fázích. <br />Nelze použít pro výstrahy tajných kódů.

phaseName: string

Hodnota vlastnosti

string

pipelineName

Pokud je k dispozici, vrátí se v tomto kanálu pouze výstrahy. <br />Jinak vrátí výstrahy zjištěné ve všech kanálech. <br />Nelze použít pro výstrahy tajných kódů.

pipelineName: string

Hodnota vlastnosti

string

ref

Pokud je k dispozici, uveďte pouze výstrahy pro tuto referenční hodnotu. <br />Pokud není k dispozici a onlyDefaultBranch je true, uveďte pouze výstrahy nalezené ve výchozí větvi nebo poslední větvi spuštění, pokud pro výchozí větev neexistuje žádná konfigurace analýzy. <br />Jinak uveďte výstrahy ze všech větví. <br />Nelze použít pro výstrahy tajných kódů.

ref: string

Hodnota vlastnosti

string

ruleId

Pokud je toto pravidlo k dispozici, vraťte pouze výstrahy. <br />Jinak vrátí upozornění všech pravidel.

ruleId: string

Hodnota vlastnosti

string

ruleName

Pokud je toto pravidlo k dispozici, vraťte pouze výstrahy. <br />Jinak vrátí upozornění pro všechna pravidla.

ruleName: string

Hodnota vlastnosti

string

severities

Pokud je tato výstraha za předpokladu poskytnuta, vraťte výstrahy pouze v těchto závažnostech. <br />Otherwise, vrátit výstrahy v jakékoli závažnosti.

severities: Severity[]

Hodnota vlastnosti

Severity[]

states

Pokud je tato výstraha za předpokladu poskytnuta, vraťte pouze výstrahy v těchto stavech. <br />Jinak vrátí výstrahy v libovolném stavu.

states: State[]

Hodnota vlastnosti

State[]

toDate

Pokud je k dispozici, vrátí se pouze výstrahy, které se naposledy zobrazily před tímto datem. <br />Jinak vrátit všechna upozornění.

toDate: Date

Hodnota vlastnosti

Date

toolName

Pokud je nástroj toolName k dispozici, vrátí pouze výstrahy zjištěné tímto nástrojem. <br />Jinak vrátí výstrahy zjištěné všemi nástroji.

toolName: string

Hodnota vlastnosti

string

validity

Pokud je tato možnost zadaná, vraťte pouze výstrahy s platností uvedenou zde. Pokud je stav platnosti Neznámý, načtěte upozornění na všechny výsledky platnosti. <br />Platí pouze pro tajné výstrahy. <br />Filtrování podle stavu platnosti může způsobit, že bude vráceno méně výstrah, než je požadováno s parametrem TOP. <br />Kvůli tomuto chování se vlastnost ContinuationToken(<![ CDATA[<název> hlavičky]]>) v hlavičce odpovědi by se mělo spoléhat na rozhodnutí, jestli je potřeba načíst další dávku.

validity: AlertValidityStatus[]

Hodnota vlastnosti

AlertValidityStatus[]