CodeAnalysisRuleSettings クラス

定義

名前空間:
Microsoft.SqlServer.Dac.CodeAnalysis
アセンブリ:
Microsoft.SqlServer.Dac.Extensions.dll
パッケージ:
Microsoft.SqlServer.DacFx.x64 v140.3881.1
パッケージ:
Microsoft.SqlServer.DacFx v150.5282.3
パッケージ:
Microsoft.SqlServer.DacFx v160.6161.0
パッケージ:
Microsoft.SqlServer.DacFx v162.2.111
パッケージ:
Microsoft.Data.Tools.Msbuild v10.0.61804.210

分析中に使用されるルールの構成に使用される設定。

分析を開始する前に、この設定オブジェクトが分析サービスによって検出されたルールに適用されます。 DisableRulesNotInSettings が true に設定されている場合、これらの設定に含まれていないルールはすべて無効になり、分析中は実行されません。

これらの設定は、エンジンによって返されるルールに対して ApplySettingsToRules(IEnumerable<RuleConfiguration>) メソッドを呼び出すことによって適用されます。

public sealed class CodeAnalysisRuleSettings : System.Collections.Generic.IEnumerable<Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration>
type CodeAnalysisRuleSettings = class
    interface seq<RuleConfiguration>
    interface IEnumerable
Public NotInheritable Class CodeAnalysisRuleSettings
Implements IEnumerable(Of RuleConfiguration)
継承
Object
CodeAnalysisRuleSettings
実装
IEnumerable<RuleConfiguration> IEnumerable

コンストラクター

名前 説明
CodeAnalysisRuleSettings()

新しい CodeAnalysisRuleSettings オブジェクトを作成します。
CodeAnalysisRuleSettings(IEnumerable<RuleConfiguration>)

一連のルールを含む新しい CodeAnalysisRuleSettings を作成します。

プロパティ

名前 説明
DisableRulesNotInSettings

これらの設定にルールが見つからない場合は無効にしてください。 既定値は "false" であるため、設定で明示的に説明されていないルールは分析中も実行されます。

メソッド

名前 説明
Add(RuleConfiguration)

ルールの一覧に新しい RuleConfiguration オブジェクトを追加します
ApplySettingsToRules(IEnumerable<RuleConfiguration>)

これらの設定を別のルール セットに適用します。
ConvertToSettingsString()

この CodeAnalysisRuleSettings オブジェクトのルール構成情報を、SSDT プロジェクト ファイル内で使用される設定文字列に変換します。 この文字列は、無効にする必要があるルール、または問題が警告ではなくエラーとして扱われるルールを定義します。 設定文字列に含まれていないルールは、既定で有効になります。
CreateFromSettingsString(String, IList<ExtensibilityError>)

SSDT プロジェクト ファイル内で使用される設定文字列に基づいて、 CodeAnalysisRuleSettings 構成を作成します。 この文字列は、無効にする必要があるルール、または問題が警告ではなくエラーとして扱われるルールを定義します。 設定文字列に含まれていないルールは、既定で有効になります。
DisableRule(String)

ルールを実行から除外します
EnableRule(String)

実行するルールを含む
FindConfiguration(String)

指定したruleIdに一致するRuleConfigurationの検索を試みます。 構成が存在しない場合は null が返されます
GetEnumerator()

GetEnumerator()
IsRuleDisabled(String)

ルール設定の特定のルールは無効になっていますか?
IsRuleProblemTreatedAsError(String)

ルール設定の特定のルールはエラーとして扱われますか?
Remove(RuleConfiguration)

ルールの一覧から RuleConfiguration オブジェクトを削除します。
TreatRuleProblemAsError(String)

ルールが見つかった問題をエラーとして扱う
TreatRuleProblemAsWarning(String)

ルールが見つかった問題を警告として扱う
TryGetRuleConfiguration(String, RuleConfiguration)

指定したruleIdに一致するRuleConfigurationの検索を試みます。

明示的なインターフェイスの実装

名前 説明
IEnumerable.GetEnumerator()

分析中に使用されるルールの構成に使用される設定。

分析を開始する前に、この設定オブジェクトが分析サービスによって検出されたルールに適用されます。 DisableRulesNotInSettings が true に設定されている場合、これらの設定に含まれていないルールはすべて無効になり、分析中は実行されません。

これらの設定は、エンジンによって返されるルールに対して ApplySettingsToRules(IEnumerable<RuleConfiguration>) メソッドを呼び出すことによって適用されます。

適用対象