Bahasa

RuleDescriptor Kelas

Definisi

Menjelaskan aturan yang ditemukan oleh mesin aturan dan mendukung konfigurasi propertinya. Deskriptor mewarisi properti dari RuleConfiguration, untuk mendukung pengaktifan/penonaktifan aturan selama analisis dan menentukan tingkat keparahan untuk masalah yang dibuat oleh aturan.

Kelas ini tidak dimaksudkan untuk menjadi subkelas oleh pengguna eksternal - instans RuleDescriptor dibuat oleh layanan analisis.

public abstract class RuleDescriptor : Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration
type RuleDescriptor = class
    inherit RuleConfiguration
Public MustInherit Class RuleDescriptor
Inherits RuleConfiguration
Warisan
RuleDescriptor

Konstruktor

Nama Deskripsi
RuleDescriptor(String)

Konstruktor yang dilindungi untuk dipanggil dengan menerapkan kelas.

Properti

Nama Deskripsi
DisplayDescription

Deskripsi aturan. Ini harus menjadi deskripsi singkat yang dapat dibaca manusia tentang apa yang dimaksudkan aturan untuk diperingatkan terhadap atau memblokir.

Ini secara otomatis dibaca dari Metadata properti

DisplayName

Nama tampilan yang menjelaskan aturan.

Ini secara otomatis dibaca dari Metadata properti

Enabled

Menentukan apakah aturan diaktifkan dan harus disertakan dalam analisis kode.

Nilai defaultnya adalah true

(Diperoleh dari RuleConfiguration)
Metadata

Yang ISqlAnalysisRuleMetadata menjelaskan aturan. Ini adalah properti yang diperlukan yang harus ditentukan oleh subkelas.

Namespace

Mendapatkan namespace untuk aturan. Ini adalah bagian dari aturan yang mendahului "." akhir dalam nama ID. Misalnya untuk ID aturan "My.Org.MyRuleName", namespace akan menjadi "My.Org".

(Diperoleh dari RuleConfiguration)
Rule

Instans aktual dari SqlAnalysisRule

RuleId

Mendapatkan Id unik yang digunakan untuk mengidentifikasi aturan. Ini adalah ID yang sepenuhnya memenuhi syarat, yang biasanya dalam bentuk "My.Org.MyRuleName".

(Diperoleh dari RuleConfiguration)
Severity

Tingkat keparahan apa yang harus dibuat oleh aturan?

Tingkat keparahan default adalah Warning

(Diperoleh dari RuleConfiguration)
ShortRuleId

Mendapatkan bagian terakhir dari ID aturan. Ini adalah bagian dari aturan yang mengikuti "." terakhir dalam nama ID. Misalnya untuk ID aturan "My.Org.MyRuleName", ID aturan singkatnya adalah "MyRuleName".

(Diperoleh dari RuleConfiguration)

Berlaku untuk