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	Возвращает пространство имен для правила. Это часть правила, которая предшествует окончательному "." в имени идентификатора. Например, для идентификатора правила "My.Org.MyRuleName" пространство имен будет "My.Org". (Унаследовано от RuleConfiguration)
Rule	Фактический экземпляр объекта SqlAnalysisRule
RuleId	Возвращает уникальный идентификатор, используемый для идентификации правила. Это полный идентификатор, который обычно будет иметь форму My.Org.MyRuleName. (Унаследовано от RuleConfiguration)
Severity	Какие проблемы должны возникнуть в правиле? Серьезность по умолчанию — Warning (Унаследовано от RuleConfiguration)
ShortRuleId	Возвращает последнюю часть идентификатора правила. Это часть правила, следующего за окончательным "." в имени идентификатора. Например, для идентификатора правила "My.Org.MyRuleName" короткий идентификатор правила будет "MyRuleName". (Унаследовано от RuleConfiguration)