RuleDescriptor Properties
Updated: April 20, 2017
Assembly: Microsoft.SqlServer.Dac.Extensions (in Microsoft.SqlServer.Dac.Extensions.dll)
| Name | Description | |
|---|---|---|
 | DisplayDescription | The description of the rule. This should be a short human readable description of what the rule is intended to warn against or block. This is automatically read from the Metadata property |
| DisplayName | Display name describing the rule. This is automatically read from the Metadata property |
| Enabled | Gets or sets a value that indicates whether the rule is enabled and should be included in the code analysis. The default value is true.(Inherited from RuleConfiguration.) |
| Metadata | The ISqlAnalysisRuleMetadata describing the rule. This is a required property that must be defined by subclasses. |
| Namespace | Gets the namespace for the rule. This is the part of the rule that precedes the final "." in the ID name. For instance for a rule ID "My.Org.MyRuleName", the namespace would be "My.Org".(Inherited from RuleConfiguration.) |
| Rule | The actual instance of the SqlAnalysisRule |
| RuleId | Gets the unique ID used to identify the rule. This is the fully qualified ID, which would usually be in the form "My.Org.MyRuleName".(Inherited from RuleConfiguration.) |
| Severity | Gets the severity of the rule. The default severity is Warning(Inherited from RuleConfiguration.) |
| ShortRuleId | Gets the last part of the rule ID. This is the part of the rule that follows the final "." in the ID name. For instance for a rule ID "My.Org.MyRuleName", the short rule ID would be "MyRuleName".(Inherited from RuleConfiguration.) |