مشاركة عبر

Get-ScriptAnalyzerRule

الوحدة النمطية:
PSScriptAnalyzer Module

يحصل على قواعد محلل البرنامج النصي على الكمبيوتر المحلي.

بناء الجملة

Default (افتراضي) 

Get-ScriptAnalyzerRule
    [[-Name] <string[]>]
    [-CustomRulePath <string[]>]
    [-RecurseCustomRulePath]
    [-Severity <string[]>]
    [<CommonParameters>]

الوصف

يحصل على قواعد محلل البرنامج النصي على الكمبيوتر المحلي. يمكنك تحديد القواعد حسب الاسم أو الخطورة أو المصدر أو نوع المصدر أو حتى كلمات معينة في وصف القاعدة.

استخدم الأمر cmdlet هذا لإنشاء مجموعات من القواعد لتضمينها واستبعادها عند تشغيل Invoke-ScriptAnalyzer cmdlet.

للحصول على معلومات حول القواعد، راجع قيمة خاصية الوصف لكل قاعدة.

تختبر الوحدة النمطية PSScriptAnalyzer التعليمات البرمجية PowerShell في برنامج نصي أو وحدة نمطية أو مورد DSC لتحديد ما إذا كانت تفي بمعايير أفضل الممارسات.

أمثلة

مثال 1 - الحصول على جميع قواعد Script Analyzer على الكمبيوتر المحلي

Get-ScriptAnalyzerRule

مثال 2 - يحصل فقط على القواعد ذات خطورة الخطأ

Get-ScriptAnalyzerRule -Severity Error

مثال 3 - تشغيل قواعد DSC فقط مع خطورة الخطأ

يقوم هذا المثال بتشغيل قواعد DSC فقط مع خطورة الخطأ على الملفات في وحدة MyDSCModule.

$DSCError = Get-ScriptAnalyzerRule -Severity Error | Where-Object SourceName -eq PSDSC
$Path = "$home\Documents\WindowsPowerShell\Modules\MyDSCModule\*"
Invoke-ScriptAnalyzerRule -Path $Path -IncludeRule $DSCError -Recurse

يعد استخدام المعلمة IncludeRuleInvoke-ScriptAnalyzerRule أكثر كفاءة من استخدام معلمة Severity، والتي يتم تطبيقها فقط بعد استخدام جميع القواعد لتحليل جميع ملفات الوحدة النمطية.

مثال 4 - الحصول على القواعد حسب الاسم والخطورة

يحصل هذا المثال على قواعد مع "المعلمة" أو "الاسم المستعار" في الاسم الذي ينشئ خطأ أو تحذيرا. يمكنك استخدام مجموعة القواعد هذه لاختبار معلمات البرنامج النصي أو الوحدة النمطية.

$TestParameters = Get-ScriptAnalyzerRule -Severity Error, Warning -Name *Parameter*, *Alias*

مثال 5 - الحصول على قواعد مخصصة

يحصل هذا المثال على القواعد القياسية والقواعد في جداStrictRules ووحدات ExtremelyStrictRules. يستخدم الأمر المعلمة RecurseCustomRulePath للحصول على قواعد محددة في الدلائل الفرعية للمسارات المطابقة.

Get-ScriptAnalyzerRule -CustomRulePath $home\Documents\WindowsPowerShell\Modules\*StrictRules -RecurseCustomRulePath

المعلمات

-CustomRulePath

بشكل افتراضي، يحصل PSScriptAnalyzer فقط على القواعد القياسية المحددة في ملف Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules.dll في الوحدة النمطية. استخدم هذه المعلمة للحصول على قواعد Script Analyzer المخصصة في المسار المحدد وقواعد Script Analyzer القياسية.

أدخل المسار إلى تجميع .NET أو وحدة نمطية تحتوي على قواعد Script Analyzer. يمكنك إدخال قيمة واحدة فقط، ولكن يتم اعتماد أحرف البدل. للحصول على قواعد في الدلائل الفرعية للمسار، استخدم المعلمة RecurseCustomRulePath.

يمكنك إنشاء قواعد مخصصة باستخدام تجميع .NET أو وحدة PowerShell، مثل قواعد محلل مجتمع في مستودع GitHub.

خصائص المعلمات

النوع:

String[]

القيمة الافتراضية:None
يدعم أحرف البدل:True
DontShow:False
الأسماء المستعارة:CustomizedRulePath

مجموعات المعلمات

(All)
Position:Named
إلزامي:False
القيمة من مسار معالجة البيانات:False
القيمة من مسار معالجة البيانات حسب اسم الخاصية:False
القيمة من الوسائط المتبقية:False

-Name

يحصل على القواعد ذات الأسماء المحددة أو أنماط الأسماء المحددة فقط. يتم دعم أحرف البدل. إذا قمت بإدراج أسماء أو أنماط متعددة، فإنه يحصل على جميع القواعد التي تطابق أي من أنماط الاسم.

خصائص المعلمات

النوع:

String[]

القيمة الافتراضية:All rules
يدعم أحرف البدل:True
DontShow:False

مجموعات المعلمات

(All)
Position:Named
إلزامي:False
القيمة من مسار معالجة البيانات:False
القيمة من مسار معالجة البيانات حسب اسم الخاصية:False
القيمة من الوسائط المتبقية:False

-RecurseCustomRulePath

البحث في موقع CustomRulePath بشكل متكرر لإضافة قواعد معرفة في الملفات في الدلائل الفرعية للمسار. بشكل افتراضي، يضيف Get-ScriptAnalyzerRule القواعد المخصصة فقط في المسار المحدد.

خصائص المعلمات

النوع:SwitchParameter
القيمة الافتراضية:False
يدعم أحرف البدل:False
DontShow:False

مجموعات المعلمات

(All)
Position:Named
إلزامي:False
القيمة من مسار معالجة البيانات:False
القيمة من مسار معالجة البيانات حسب اسم الخاصية:False
القيمة من الوسائط المتبقية:False

-Severity

يحصل فقط على القواعد ذات قيم الخطورة المحددة. القيم الصالحة هي:

  • ‏‏‏‏‏‏‏‏‏‏‏‏‏‏‏‏‏‏‏المعلومات
  • Warning
  • Error

خصائص المعلمات

النوع:

String[]

القيمة الافتراضية:All rules
يدعم أحرف البدل:False
DontShow:False

مجموعات المعلمات

(All)
Position:Named
إلزامي:False
القيمة من مسار معالجة البيانات:False
القيمة من مسار معالجة البيانات حسب اسم الخاصية:False
القيمة من الوسائط المتبقية:False

CommonParameters

يدعم cmdlet هذا المعلمات الشائعة: -Debug و -ErrorAction و -ErrorVariable و -InformationAction و -InformationVariable و -OutBuffer و -OutVariable و -PipelineVariable و -ProgressAction و -Verbose و -WarningAction و -WarningVariable. لمزيد من المعلومات، راجع about_CommonParameters.

الإدخالات

None

لا يمكنك توجيه الإدخال إلى أمر cmdlet هذا.

المخرجات

Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.RuleInfo

كائن RuleInfo هو كائن مخصص تم إنشاؤه خصيصا ل Script Analyzer.