Langage

RuleDescriptor Classe

Définition

Décrit une règle découverte par le moteur de règles et prend en charge la configuration de ses propriétés. Les descripteurs héritent des propriétés de RuleConfiguration, pour prendre en charge l’activation/la désactivation de la règle pendant l’analyse et la spécification de la gravité des problèmes créés par la règle.

Cette classe n’est pas destinée à être des sous-classes par des utilisateurs externes : les instances de RuleDescriptor sont créées par le service d’analyse.

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

Constructeurs

Nom Description
RuleDescriptor(String)

Constructeur protégé à appeler en implémentant des classes.

Propriétés

Nom Description
DisplayDescription

Description de la règle. Il doit s’agir d’une brève description lisible par l’homme de ce que la règle est destinée à avertir ou bloquer.

Cette propriété est automatiquement lue à partir de la Metadata propriété

DisplayName

Nom complet décrivant la règle.

Cette propriété est automatiquement lue à partir de la Metadata propriété

Enabled

Spécifie si la règle est activée et doit être incluse dans l’analyse du code.

La valeur par défaut est true

(Hérité de RuleConfiguration)
Metadata

ISqlAnalysisRuleMetadata Description de la règle. Il s’agit d’une propriété obligatoire qui doit être définie par les sous-classes.

Namespace

Obtient l’espace de noms de la règle. Il s’agit de la partie de la règle qui précède le dernier « ». dans le nom de l’ID. Par exemple, pour un ID de règle « My.Org.MyRuleName », l’espace de noms est « My.Org ».

(Hérité de RuleConfiguration)
Rule

Instance réelle du SqlAnalysisRule

RuleId

Obtient l’ID unique utilisé pour identifier la règle. Il s’agit de l’ID complet, qui se présente généralement sous la forme « My.Org.MyRuleName ».

(Hérité de RuleConfiguration)
Severity

Quels sont les problèmes de gravité créés par la règle ?

La gravité par défaut est Warning

(Hérité de RuleConfiguration)
ShortRuleId

Obtient la dernière partie de l’ID de règle. Il s’agit de la partie de la règle qui suit le dernier « ». dans le nom de l’ID. Par exemple, pour un ID de règle « My.Org.MyRuleName », l’ID de règle court est « MyRuleName ».

(Hérité de RuleConfiguration)

S’applique à