SearchCriteria interface

Pakiet:

azure-devops-extension-api

Właściwości

alertIds	Jeśli zostanie podana, zwracaj tylko alerty z określonymi identyfikatorami. <br/>W przeciwnym razie zwróć dowolny alert.
alertType	W przypadku podania zwracane są tylko alerty tego typu. W przeciwnym razie zwróć alerty wszystkich typów.
confidenceLevels	W przypadku podania zwracane są tylko alerty na tych poziomach ufności. <br />Zarówno Wysoki, jak i Inne należy określić, aby pobrać alerty dotyczące wszystkich poziomów ufności. <br />W przeciwnym razie zwracaj alerty o wysokim poziomie ufności. <br />Dotyczy tylko alertów wpisów tajnych.
dependencyName	W przypadku podania zwracane są tylko alerty dotyczące tej zależności. <br/>W przeciwnym razie zwróć alerty dla wszystkich zależności. <br />W przesłaniu sarif zależność (lub składnik) jest określona w wyniku. RelatedLocations[].logicalLocation. <br />Nie dotyczy alertów wpisów tajnych.
fromDate	W przypadku podania zwracaj tylko alerty ostatnio widoczne po tej dacie. <br/>W przeciwnym razie zwróć wszystkie alerty.
hasLinkedWorkItems	Jeśli zostanie podana, filtruje alerty na podstawie tego, czy mają połączone elementy robocze. <BR />Ustaw na "true", aby zwracać tylko alerty z powiązanymi zadaniami pracy. <BR />Ustaw na "fałszywe", aby zwracać tylko powiadomienia bez powiązanych zadań. <br />Jeśli nie jest udostępniony, zwraca wszystkie alerty niezależnie od powiązanych zadań roboczych. <br />Nie dotyczy alertów o skanowaniu tajnych i zależności.
keywords	W przypadku podania zwracaj tylko alerty, których tytuły są zgodne z tym wzorcem.
licenseName	Jeśli zostanie podana, zwracane są tylko alerty utworzone dla zależności z tą licencją. <br/>W przeciwnym razie zwróć alerty dotyczące wszystkich licencji. <br />W przesłaniu sarif licencja na zależność (lub składnik) jest określona w wyniku. RelatedLocations[].logicalLocation.properties.license. <br />Nie dotyczy alertów wpisów tajnych.
modifiedSince	Jeśli zostanie podana, zwracaj tylko alerty, które zostały zmodyfikowane od tej daty. <br/>W przeciwnym razie zwróć wszystkie alerty.
onlyDefaultBranch	Jeśli wartość true lub nie jest ustawiona, zwracane są tylko alerty znalezione w domyślnej gałęzi repozytorium. <br/>Jeśli w gałęzi domyślnej nie ukończono żadnych przebiegów, ostatnie uruchomienie jest używane zamiast tego niezależnie od gałęzi używanej do tego uruchomienia. Jeśli wartość false, zwróć alerty ze wszystkich gałęzi. <br/>Ta opcja jest ignorowana w przypadku podania odwołania. <br />Nie dotyczy alertów wpisów tajnych.
phaseId	W przypadku podania parametru pipelineName zwracane są tylko alerty wykryte w tej fazie potoku <br/>W przeciwnym razie zwracają alerty wykryte we wszystkich fazach. <br />Nie dotyczy alertów wpisów tajnych.
phaseName	W przypadku podania parametru pipelineName zwracane są tylko alerty wykryte w tej fazie potoku <br/>W przeciwnym razie zwracają alerty wykryte we wszystkich fazach. <br />Nie dotyczy alertów wpisów tajnych.
pipelineName	W przypadku podania zwracane są tylko alerty wykryte w tym potoku. <br/>W przeciwnym razie zwracaj alerty wykryte we wszystkich potokach. <br />Nie dotyczy alertów wpisów tajnych.
ref	Jeśli zostanie podana wartość , uwzględnij tylko alerty dotyczące tego odwołania. <br />Jeśli nie podano i tylkoDefaultBranch ma wartość true, uwzględnij alerty znalezione w gałęzi domyślnej lub ostatniej gałęzi uruchamiania, jeśli nie ma konfiguracji analizy dla gałęzi domyślnej. <br/>W przeciwnym razie uwzględnij alerty ze wszystkich gałęzi. <br />Nie dotyczy alertów wpisów tajnych.
ruleId	Jeśli zostanie podana, zwracaj tylko alerty dla tej reguły. <br/>W przeciwnym razie zwróć alerty wszystkich reguł.
ruleName	Jeśli zostanie podana, zwracaj tylko alerty dla tej reguły. <br/>W przeciwnym razie zwróć alerty dla wszystkich reguł.
severities	Jeśli zostanie podana, zwracaj tylko alerty o tych ważnościach. <br />W przeciwnym razie zwracaj alerty o dowolnej ważności.
states	W przypadku podania zwracane są tylko alerty w tych stanach. <br/>W przeciwnym razie zwracają alerty w dowolnym stanie.
toDate	Jeśli zostanie podana, zwróć tylko alerty ostatnio widoczne przed tą datą. <br/>W przeciwnym razie zwróć wszystkie alerty.
toolName	W przypadku podania parametru toolName zwracane są tylko alerty wykryte przez to narzędzie. <br/>W przeciwnym razie zwróć alerty wykryte przez wszystkie narzędzia.
validity	Jeśli zostanie podana, zwracaj tylko alerty z ważnością określoną tutaj. Jeśli stan ważności to Nieznany, pobierz alerty wszystkich wyników ważności. <br />Dotyczy tylko alertów wpisów tajnych. <br />Filtrowanie według stanu ważności może spowodować, że zostanie zwrócona mniejsza liczba alertów niż żądano za pomocą parametru TOP. <br />Ze względu na to zachowanie, ContinuationToken(<![ CDATA[<nazwa> nagłówka]]>) w nagłówku odpowiedzi powinien być wykorzystany do podjęcia decyzji, czy konieczne jest pobranie kolejnej partii.

Szczegóły nieruchomości

alertIds

Jeśli zostanie podana, zwracaj tylko alerty z określonymi identyfikatorami. <br/>W przeciwnym razie zwróć dowolny alert.

alertIds: number[]

Wartość nieruchomości

number[]

alertType

W przypadku podania zwracane są tylko alerty tego typu. W przeciwnym razie zwróć alerty wszystkich typów.

alertType: AlertType

Wartość nieruchomości

AlertType

confidenceLevels

W przypadku podania zwracane są tylko alerty na tych poziomach ufności. <br />Zarówno Wysoki, jak i Inne należy określić, aby pobrać alerty dotyczące wszystkich poziomów ufności. <br />W przeciwnym razie zwracaj alerty o wysokim poziomie ufności. <br />Dotyczy tylko alertów wpisów tajnych.

confidenceLevels: Confidence[]

Wartość nieruchomości

Confidence[]

dependencyName

W przypadku podania zwracane są tylko alerty dotyczące tej zależności. <br/>W przeciwnym razie zwróć alerty dla wszystkich zależności. <br />W przesłaniu sarif zależność (lub składnik) jest określona w wyniku. RelatedLocations[].logicalLocation. <br />Nie dotyczy alertów wpisów tajnych.

dependencyName: string

Wartość nieruchomości

string

fromDate

W przypadku podania zwracaj tylko alerty ostatnio widoczne po tej dacie. <br/>W przeciwnym razie zwróć wszystkie alerty.

fromDate: Date

Wartość nieruchomości

Date

hasLinkedWorkItems

Jeśli zostanie podana, filtruje alerty na podstawie tego, czy mają połączone elementy robocze. <BR />Ustaw na "true", aby zwracać tylko alerty z powiązanymi zadaniami pracy. <BR />Ustaw na "fałszywe", aby zwracać tylko powiadomienia bez powiązanych zadań. <br />Jeśli nie jest udostępniony, zwraca wszystkie alerty niezależnie od powiązanych zadań roboczych. <br />Nie dotyczy alertów o skanowaniu tajnych i zależności.

hasLinkedWorkItems: boolean

Wartość nieruchomości

boolean

keywords

W przypadku podania zwracaj tylko alerty, których tytuły są zgodne z tym wzorcem.

keywords: string

Wartość nieruchomości

string

licenseName

Jeśli zostanie podana, zwracane są tylko alerty utworzone dla zależności z tą licencją. <br/>W przeciwnym razie zwróć alerty dotyczące wszystkich licencji. <br />W przesłaniu sarif licencja na zależność (lub składnik) jest określona w wyniku. RelatedLocations[].logicalLocation.properties.license. <br />Nie dotyczy alertów wpisów tajnych.

licenseName: string

Wartość nieruchomości

string

modifiedSince

Jeśli zostanie podana, zwracaj tylko alerty, które zostały zmodyfikowane od tej daty. <br/>W przeciwnym razie zwróć wszystkie alerty.

modifiedSince: Date

Wartość nieruchomości

Date

onlyDefaultBranch

Jeśli wartość true lub nie jest ustawiona, zwracane są tylko alerty znalezione w domyślnej gałęzi repozytorium. <br/>Jeśli w gałęzi domyślnej nie ukończono żadnych przebiegów, ostatnie uruchomienie jest używane zamiast tego niezależnie od gałęzi używanej do tego uruchomienia. Jeśli wartość false, zwróć alerty ze wszystkich gałęzi. <br/>Ta opcja jest ignorowana w przypadku podania odwołania. <br />Nie dotyczy alertów wpisów tajnych.

onlyDefaultBranch: boolean

Wartość nieruchomości

boolean

phaseId

W przypadku podania parametru pipelineName zwracane są tylko alerty wykryte w tej fazie potoku <br/>W przeciwnym razie zwracają alerty wykryte we wszystkich fazach. <br />Nie dotyczy alertów wpisów tajnych.

phaseId: string

Wartość nieruchomości

string

phaseName

W przypadku podania parametru pipelineName zwracane są tylko alerty wykryte w tej fazie potoku <br/>W przeciwnym razie zwracają alerty wykryte we wszystkich fazach. <br />Nie dotyczy alertów wpisów tajnych.

phaseName: string

Wartość nieruchomości

string

pipelineName

W przypadku podania zwracane są tylko alerty wykryte w tym potoku. <br/>W przeciwnym razie zwracaj alerty wykryte we wszystkich potokach. <br />Nie dotyczy alertów wpisów tajnych.

pipelineName: string

Wartość nieruchomości

string

ref

Jeśli zostanie podana wartość , uwzględnij tylko alerty dotyczące tego odwołania. <br />Jeśli nie podano i tylkoDefaultBranch ma wartość true, uwzględnij alerty znalezione w gałęzi domyślnej lub ostatniej gałęzi uruchamiania, jeśli nie ma konfiguracji analizy dla gałęzi domyślnej. <br/>W przeciwnym razie uwzględnij alerty ze wszystkich gałęzi. <br />Nie dotyczy alertów wpisów tajnych.

ref: string

Wartość nieruchomości

string

ruleId

Jeśli zostanie podana, zwracaj tylko alerty dla tej reguły. <br/>W przeciwnym razie zwróć alerty wszystkich reguł.

ruleId: string

Wartość nieruchomości

string

ruleName

Jeśli zostanie podana, zwracaj tylko alerty dla tej reguły. <br/>W przeciwnym razie zwróć alerty dla wszystkich reguł.

ruleName: string

Wartość nieruchomości

string

severities

Jeśli zostanie podana, zwracaj tylko alerty o tych ważnościach. <br />W przeciwnym razie zwracaj alerty o dowolnej ważności.

severities: Severity[]

Wartość nieruchomości

Severity[]

states

W przypadku podania zwracane są tylko alerty w tych stanach. <br/>W przeciwnym razie zwracają alerty w dowolnym stanie.

states: State[]

Wartość nieruchomości

State[]

toDate

Jeśli zostanie podana, zwróć tylko alerty ostatnio widoczne przed tą datą. <br/>W przeciwnym razie zwróć wszystkie alerty.

toDate: Date

Wartość nieruchomości

Date

toolName

W przypadku podania parametru toolName zwracane są tylko alerty wykryte przez to narzędzie. <br/>W przeciwnym razie zwróć alerty wykryte przez wszystkie narzędzia.

toolName: string

Wartość nieruchomości

string

validity

Jeśli zostanie podana, zwracaj tylko alerty z ważnością określoną tutaj. Jeśli stan ważności to Nieznany, pobierz alerty wszystkich wyników ważności. <br />Dotyczy tylko alertów wpisów tajnych. <br />Filtrowanie według stanu ważności może spowodować, że zostanie zwrócona mniejsza liczba alertów niż żądano za pomocą parametru TOP. <br />Ze względu na to zachowanie, ContinuationToken(<![ CDATA[<nazwa> nagłówka]]>) w nagłówku odpowiedzi powinien być wykorzystany do podjęcia decyzji, czy konieczne jest pobranie kolejnej partii.

validity: AlertValidityStatus[]

Wartość nieruchomości

AlertValidityStatus[]