SearchCriteria interface

パッケージ:

azure-devops-extension-api

プロパティ

alertIds	指定した場合は、ID が指定されたアラートのみを返します。 <br/>それ以外の場合は、アラートを返します。
alertType	指定した場合は、この種類のアラートのみを返します。 それ以外の場合は、すべての種類のアラートを返します。
confidenceLevels	指定した場合は、これらの信頼度レベルでのみアラートを返します。 <br />Both High と Other を指定して、すべての信頼レベルのアラートをフェッチする必要があります。 <br />それ以外の場合は、信頼度の高いアラートを返します。 <br />シークレット アラートに適用されます。
dependencyName	指定した場合、この依存関係のアラートのみが返されます。 <br />それ以外の場合は、すべての依存関係のアラートを返します。 <br/>サリフ提出では、結果として依存関係 (またはコンポーネント) が指定されます。RelatedLocations[].logicalLocation. <br />シークレット アラートには適用されません。
fromDate	指定した場合は、この日付より後に最後に表示されたアラートのみを返します。 <br/>それ以外の場合は、すべてのアラートを返します。
keywords	指定した場合は、タイトルがこのパターンと一致するアラートのみを返します。
licenseName	指定した場合、このライセンスとの依存関係のために作成されたアラートのみが返されます。 <br/>それ以外の場合は、すべてのライセンスのアラートを返します。 <br/>sarif 申請では、依存関係 (またはコンポーネント) のライセンスが結果で指定されます。RelatedLocations[].logicalLocation.properties.license. <br />シークレット アラートには適用されません。
modifiedSince	指定した場合は、この日付以降に変更されたアラートのみを返します。 <br/>それ以外の場合は、すべてのアラートを返します。
onlyDefaultBranch	true または設定されていない場合は、リポジトリの既定のブランチで検出されたアラートのみを返します。 <br/>既定のブランチで実行が完了していない場合は、その実行に使用されたブランチに関係なく、最後の実行が代わりに使用されます。 false の場合は、すべてのブランチからアラートを返します。 <br/>ref が指定されている場合、このオプションは無視されます。 <br />シークレット アラートには適用されません。
phaseId	pipelineName を指定した場合は、このパイプライン フェーズで検出されたアラートのみを返 <br/>。それ以外の場合は、すべてのフェーズで検出されたアラートを返します。 <br />シークレット アラートには適用されません。
phaseName	pipelineName を指定した場合は、このパイプライン フェーズで検出されたアラートのみを返 <br/>。それ以外の場合は、すべてのフェーズで検出されたアラートを返します。 <br />シークレット アラートには適用されません。
pipelineName	指定した場合は、このパイプラインで検出されたアラートのみを返します。 <br/>それ以外の場合は、すべてのパイプラインで検出されたアラートを返します。 <br />シークレット アラートには適用されません。
ref	指定した場合は、この参照のアラートのみを含めます。<br/>指定されておらず、OnlyDefaultBranch が true の場合は、既定のブランチの分析構成がない場合は、既定のブランチまたは最後の実行ブランチで検出されたアラートのみを含めます。 <br/>それ以外の場合は、すべてのブランチからのアラートを含めます。 <br />シークレット アラートには適用されません。
ruleId	指定した場合は、このルールのアラートのみを返します。 <br/>それ以外の場合は、すべてのルールのアラートを返します。
ruleName	指定した場合は、このルールのアラートのみを返します。 <br/>それ以外の場合は、すべてのルールのアラートを返します。
severities	指定した場合は、これらの重大度でのみアラートを返します。 <br />それ以外の場合は、任意の重大度でアラートを返します。
states	指定した場合は、これらの状態のアラートのみを返します。 <br/>それ以外の場合は、任意の状態でアラートを返します。
toDate	指定した場合は、この日付より前に最後に表示されたアラートのみを返します。 <br/>それ以外の場合は、すべてのアラートを返します。
toolName	toolName を指定した場合は、このツールによって検出されたアラートのみを返します。 <br/>それ以外の場合は、すべてのツールによって検出されたアラートを返します。
validity	指定した場合は、ここで指定した有効性を持つアラートのみを返します。 有効性の状態が [不明] の場合は、すべての有効性の結果のアラートをフェッチします。 <br />シークレット アラートに適用されます。 <br />有効性ステータスでフィルタリングすると、TOP パラメータで要求されたアラートよりも返されるアラートが少なくなる可能性があります。 <br />この動作により、ContinuationToken(<![応答ヘッダーのCDATA[<ヘッダー名>]]]>) は、別のバッチをフェッチする必要があるかどうかを判断するために依存する必要があります。

プロパティの詳細

alertIds

指定した場合は、ID が指定されたアラートのみを返します。 <br/>それ以外の場合は、アラートを返します。

alertIds: number[]

プロパティ値

number[]

alertType

指定した場合は、この種類のアラートのみを返します。 それ以外の場合は、すべての種類のアラートを返します。

alertType: AlertType

プロパティ値

AlertType

confidenceLevels

指定した場合は、これらの信頼度レベルでのみアラートを返します。 <br />Both High と Other を指定して、すべての信頼レベルのアラートをフェッチする必要があります。 <br />それ以外の場合は、信頼度の高いアラートを返します。 <br />シークレット アラートに適用されます。

confidenceLevels: Confidence[]

プロパティ値

Confidence[]

dependencyName

指定した場合、この依存関係のアラートのみが返されます。 <br />それ以外の場合は、すべての依存関係のアラートを返します。 <br/>サリフ提出では、結果として依存関係 (またはコンポーネント) が指定されます。RelatedLocations[].logicalLocation. <br />シークレット アラートには適用されません。

dependencyName: string

プロパティ値

string

fromDate

指定した場合は、この日付より後に最後に表示されたアラートのみを返します。 <br/>それ以外の場合は、すべてのアラートを返します。

fromDate: Date

プロパティ値

Date

keywords

指定した場合は、タイトルがこのパターンと一致するアラートのみを返します。

keywords: string

プロパティ値

string

licenseName

指定した場合、このライセンスとの依存関係のために作成されたアラートのみが返されます。 <br/>それ以外の場合は、すべてのライセンスのアラートを返します。 <br/>sarif 申請では、依存関係 (またはコンポーネント) のライセンスが結果で指定されます。RelatedLocations[].logicalLocation.properties.license. <br />シークレット アラートには適用されません。

licenseName: string

プロパティ値

string

modifiedSince

指定した場合は、この日付以降に変更されたアラートのみを返します。 <br/>それ以外の場合は、すべてのアラートを返します。

modifiedSince: Date

プロパティ値

Date

onlyDefaultBranch

true または設定されていない場合は、リポジトリの既定のブランチで検出されたアラートのみを返します。 <br/>既定のブランチで実行が完了していない場合は、その実行に使用されたブランチに関係なく、最後の実行が代わりに使用されます。 false の場合は、すべてのブランチからアラートを返します。 <br/>ref が指定されている場合、このオプションは無視されます。 <br />シークレット アラートには適用されません。

onlyDefaultBranch: boolean

プロパティ値

boolean

phaseId

pipelineName を指定した場合は、このパイプライン フェーズで検出されたアラートのみを返 <br/>。それ以外の場合は、すべてのフェーズで検出されたアラートを返します。 <br />シークレット アラートには適用されません。

phaseId: string

プロパティ値

string

phaseName

pipelineName を指定した場合は、このパイプライン フェーズで検出されたアラートのみを返 <br/>。それ以外の場合は、すべてのフェーズで検出されたアラートを返します。 <br />シークレット アラートには適用されません。

phaseName: string

プロパティ値

string

pipelineName

指定した場合は、このパイプラインで検出されたアラートのみを返します。 <br/>それ以外の場合は、すべてのパイプラインで検出されたアラートを返します。 <br />シークレット アラートには適用されません。

pipelineName: string

プロパティ値

string

ref

指定した場合は、この参照のアラートのみを含めます。<br/>指定されておらず、OnlyDefaultBranch が true の場合は、既定のブランチの分析構成がない場合は、既定のブランチまたは最後の実行ブランチで検出されたアラートのみを含めます。 <br/>それ以外の場合は、すべてのブランチからのアラートを含めます。 <br />シークレット アラートには適用されません。

ref: string

プロパティ値

string

ruleId

指定した場合は、このルールのアラートのみを返します。 <br/>それ以外の場合は、すべてのルールのアラートを返します。

ruleId: string

プロパティ値

string

ruleName

指定した場合は、このルールのアラートのみを返します。 <br/>それ以外の場合は、すべてのルールのアラートを返します。

ruleName: string

プロパティ値

string

severities

指定した場合は、これらの重大度でのみアラートを返します。 <br />それ以外の場合は、任意の重大度でアラートを返します。

severities: Severity[]

プロパティ値

Severity[]

states

指定した場合は、これらの状態のアラートのみを返します。 <br/>それ以外の場合は、任意の状態でアラートを返します。

states: State[]

プロパティ値

State[]

toDate

指定した場合は、この日付より前に最後に表示されたアラートのみを返します。 <br/>それ以外の場合は、すべてのアラートを返します。

toDate: Date

プロパティ値

Date

toolName

toolName を指定した場合は、このツールによって検出されたアラートのみを返します。 <br/>それ以外の場合は、すべてのツールによって検出されたアラートを返します。

toolName: string

プロパティ値

string

validity

指定した場合は、ここで指定した有効性を持つアラートのみを返します。 有効性の状態が [不明] の場合は、すべての有効性の結果のアラートをフェッチします。 <br />シークレット アラートに適用されます。 <br />有効性ステータスでフィルタリングすると、TOP パラメータで要求されたアラートよりも返されるアラートが少なくなる可能性があります。 <br />この動作により、ContinuationToken(<![応答ヘッダーのCDATA[<ヘッダー名>]]]>) は、別のバッチをフェッチする必要があるかどうかを判断するために依存する必要があります。

validity: AlertValidityStatus[]

プロパティ値

AlertValidityStatus[]