RuleDescriptor 类

定义

命名空间:

Microsoft.SqlServer.Dac.CodeAnalysis

程序集:

Microsoft.SqlServer.Dac.Extensions.dll

包:

Microsoft.SqlServer.DacFx v162.2.111

描述规则引擎发现的规则，并支持配置其属性。 描述符继承属性 RuleConfiguration，以支持在分析期间启用/禁用规则，并为规则创建的问题指定严重性。

此类不应由外部用户创建子类 - 分析服务创建的实例 RuleDescriptor 。

public abstract class RuleDescriptor : Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration

type RuleDescriptor = class
    inherit RuleConfiguration

Public MustInherit Class RuleDescriptor
Inherits RuleConfiguration

继承

Object

RuleConfiguration

RuleDescriptor

构造函数

名称	说明
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)