RuleDescriptor クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
ルール エンジンによって検出されたルールについて説明し、そのプロパティの構成をサポートします。 記述子は RuleConfigurationからプロパティを継承し、分析中のルールの有効化/無効化と、ルールによって作成された問題の重大度の指定をサポートします。
このクラスは、外部ユーザーによるサブクラスではなく、 RuleDescriptor のインスタンスが分析サービスによって作成されます。
public abstract class RuleDescriptor : Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfigurationtype RuleDescriptor = class
inherit RuleConfigurationPublic MustInherit Class RuleDescriptor
Inherits RuleConfiguration- 継承
コンストラクター
| 名前 | 説明 |
|---|---|
| RuleDescriptor(String) |
クラスを実装することによって呼び出される保護されたコンストラクター。 |
プロパティ
| 名前 | 説明 |
|---|---|
| DisplayDescription |
ルールの説明。 これは、ルールが警告またはブロックすることを意図している内容を人間が判読できる短い説明にする必要があります。 これは、 Metadata プロパティから自動的に読み取られます |
| DisplayName |
ルールを説明する表示名。 これは、 Metadata プロパティから自動的に読み取られます |
| Enabled |
ルールが有効になっているかどうかを指定し、コード分析に含める必要があります。 既定値は true です (継承元 RuleConfiguration) |
| Metadata |
ルールを説明する ISqlAnalysisRuleMetadata 。 これは、サブクラスで定義する必要がある必須のプロパティです。 |
| Namespace |
規則の名前空間を取得します。 これは、ID 名の最後の "." の前にある規則の一部です。 たとえば、ルール ID "My.Org.MyRuleName" の場合、名前空間は "My.Org" になります。 (継承元 RuleConfiguration) |
| Rule |
の実際のインスタンス SqlAnalysisRule |
| RuleId |
ルールを識別するために使用される一意の ID を取得します。 これは完全修飾 ID で、通常は "My.Org.MyRuleName" の形式になります。 (継承元 RuleConfiguration) |
| Severity |
ルールによって作成される問題の重大度は何ですか? 既定の重大度は Warning (継承元 RuleConfiguration) |
| ShortRuleId |
ルール ID の最後の部分を取得します。 これは、ID 名の最後の "." に続くルールの一部です。 たとえば、ルール ID "My.Org.MyRuleName" の場合、短いルール ID は "MyRuleName" になります。 (継承元 RuleConfiguration) |