ISqlAnalysisRuleMetadata Interface

  • 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

The metadata describing a rule - its namespace, id, scope etc.

public interface ISqlAnalysisRuleMetadata : Microsoft.SqlServer.Dac.Extensibility.IStandardMetadata
type ISqlAnalysisRuleMetadata = interface
    interface IStandardMetadata
Public Interface ISqlAnalysisRuleMetadata
Implements IStandardMetadata
Derived
Implements
IStandardMetadata

Properties

Category

(Optional) Category used to group the rule in Visual Studio UI. This should never be localized
Description

The description of the rule. This should be a short human readable description of what the rule is intended to warn against or block.
DisplayName (Inherited from IStandardMetadata)
Id (Inherited from IStandardMetadata)
PlatformCompatibility (Inherited from IStandardMetadata)
RuleScope

The scope of this rule. Choose between Element and Model. Note that for element scoped rules, the SupportedElementTypes property must return one or more element types that can are supported for analysis by the rule
Version (Inherited from IStandardMetadata)

Applies to