RuleDescriptor Klasse

Definition

Beschreibt eine Vom Regelmodul ermittelte Regel und unterstützt die Konfiguration der zugehörigen Eigenschaften. Deskriptoren erben Eigenschaften von RuleConfiguration, um die Aktivierung/Deaktivierung der Regel während der Analyse zu unterstützen und den Schweregrad für Probleme anzugeben, die von der Regel erstellt wurden.

Diese Klasse ist nicht als Unterklassen von externen Benutzern gedacht – Instanzen von RuleDescriptor werden vom Analysedienst erstellt.

public abstract class RuleDescriptor : Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration
type RuleDescriptor = class
    inherit RuleConfiguration
Public MustInherit Class RuleDescriptor
Inherits RuleConfiguration
Vererbung
RuleDescriptor

Konstruktoren

Name Beschreibung
RuleDescriptor(String)

Geschützter Konstruktor, der von der Implementierung von Klassen aufgerufen werden soll.

Eigenschaften

Name Beschreibung
DisplayDescription

Die Beschreibung der Regel. Dies sollte eine kurze lesbare Beschreibung der Regel sein, die vor oder blockieren soll.

Dies wird automatisch aus der Metadata Eigenschaft gelesen.

DisplayName

Anzeigename, der die Regel beschreibt.

Dies wird automatisch aus der Metadata Eigenschaft gelesen.

Enabled

Gibt an, ob die Regel aktiviert ist und in die Codeanalyse einbezogen werden soll.

Der Standardwert ist true.

(Geerbt von RuleConfiguration)
Metadata

Die ISqlAnalysisRuleMetadata Beschreibung der Regel. Dies ist eine erforderliche Eigenschaft, die von Unterklassen definiert werden muss.

Namespace

Ruft den Namespace für die Regel ab. Dies ist der Teil der Regel, der vor dem endgültigen "." im ID-Namen steht. Beispielsweise für eine Regel-ID "My.Org.MyRuleName", lautet der Namespace "My.Org".

(Geerbt von RuleConfiguration)
Rule

Die tatsächliche Instanz der SqlAnalysisRule

RuleId

Ruft die eindeutige ID ab, die zum Identifizieren der Regel verwendet wird. Dies ist die vollqualifizierte ID, die in der Regel in form "My.Org.MyRuleName" liegt.

(Geerbt von RuleConfiguration)
Severity

Welchen Schweregrad sollten von der Regel erstellte Probleme haben?

Der Standardschweregrad ist Warning

(Geerbt von RuleConfiguration)
ShortRuleId

Ruft den letzten Teil der Regel-ID ab. Dies ist der Teil der Regel, der dem endgültigen "." im ID-Namen folgt. Beispielsweise für eine Regel-ID "My.Org.MyRuleName", lautet die kurze Regel-ID "MyRuleName".

(Geerbt von RuleConfiguration)

Gilt für: