Share via

RuleConfiguration Class

  • Reference

Definition

Namespace:
Microsoft.SqlServer.Dac.CodeAnalysis
Assembly:
Microsoft.SqlServer.Dac.Extensions.dll
Package:
Microsoft.SqlServer.DacFx.x64 v140.3881.1
Package:
Microsoft.SqlServer.DacFx v150.5282.3
Package:
Microsoft.SqlServer.DacFx v160.6161.0
Package:
Microsoft.SqlServer.DacFx v162.2.111
Package:
Microsoft.Data.Tools.Msbuild v10.0.61804.210

Specifies how a rule should be configured - should this be enabled or disabled? What severity should be applied for the rule?

public class RuleConfiguration
type RuleConfiguration = class
Public Class RuleConfiguration
Inheritance
Object
RuleConfiguration
Derived

Constructors

RuleConfiguration(String, Boolean, SqlRuleProblemSeverity)

Creates a new RuleConfiguration for a rule.
RuleConfiguration(String)

Creates a new RuleConfiguration for a rule, using the default settings for Enabled and Severity.

Properties

Enabled

Specifies if the rule is enabled and should be included in the code analysis.

The default value is true
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".
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".
Severity

What severity should problems created by the rule have?

The default severity is Warning
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".

Applies to