Get-ScriptAnalyzerRule

Modul:
PSScriptAnalyzer Module

Lekéri a szkriptelemző szabályokat a helyi számítógépen.

Szintaxis

Default (Alapértelmezett) 

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

Leírás

Lekéri a szkriptelemző szabályokat a helyi számítógépen. Kiválaszthat szabályokat név, súlyosság, forrás vagy SourceType, vagy akár adott szavak alapján a szabály leírásában.

Ezzel a parancsmaggal olyan szabálygyűjteményeket hozhat létre, amelyet belefoglalhat és kizárhat a Invoke-ScriptAnalyzer parancsmag futtatásakor.

A szabályokkal kapcsolatos információkért tekintse meg az egyes szabályok Leírás tulajdonságának értékét.

A PSScriptAnalyzer modul egy szkriptben, modulban vagy DSC-erőforrásban teszteli a PowerShell-kódot annak megállapításához, hogy megfelel-e az ajánlott eljárásokra vonatkozó szabványoknak.

Példák

1. PÉLDA – Az összes szkriptelemző szabály lekérése a helyi számítógépen

Get-ScriptAnalyzerRule

2. PÉLDA – Csak a hiba súlyosságú szabályokat kapja meg

Get-ScriptAnalyzerRule -Severity Error

3. PÉLDA – Csak a hiba súlyosságú DSC-szabályok futtatása

Ez a példa csak a MyDSCModule modulban található fájlok hiba súlyosságú DSC-szabályait futtatja.

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

A Invoke-ScriptAnalyzerRule paraméterének használata hatékonyabb, mint a Súlyossági paraméter használata, amelyet csak akkor alkalmazunk, ha az összes szabályt az összes modulfájl elemzéséhez használjuk.

4. PÉLDA – Szabályok lekérése név és súlyosság szerint

Ez a példa a hibát vagy figyelmeztetést generáló névben a "Paraméter" vagy az "Alias" típusú szabályokat kapja meg. Ezzel a szabálykészlettel tesztelheti a szkript vagy modul paramétereit.

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

5. PÉLDA – Egyéni szabályok lekérése

Ez a példa beolvasja a standard szabályokat és a szabályokat a VeryStrictRules és ExtremelyStrictRules modulokban. A parancs a RecurseCustomRulePath paramétert használja a megfelelő útvonalak alkönyvtáraiban definiált szabályok lekéréséhez.

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

Paraméterek

-CustomRulePath

Alapértelmezés szerint a PSScriptAnalyzer csak a modul Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules.dll fájljában megadott standard szabályokat kapja meg. Ezzel a paramétert használva lekérheti az egyéni Szkriptelemző szabályokat a megadott útvonalon és a szabványos Szkriptelemző szabályokban.

Adja meg a szkriptelemző szabályokat tartalmazó .NET-szerelvény vagy -modul elérési útját. Csak egy értéket adhat meg, de a helyettesítő karakterek támogatottak. Ha az elérési út alkönyvtáraiban szeretne szabályokat lekérni, használja a RecurseCustomRulePath paramétert.

Egyéni szabályokat .NET-szerelvény vagy PowerShell-modul használatával hozhat létre, például a GitHub-adattár Community Analyzer Rules.

Paramétertulajdonságok

Típus:

String[]

Alapértelmezett érték:None
Támogató vadkártyák:True
Don't Show:False
Aliasok:TestreszabottSzabályÚtvonal

Paraméterhalmazok

(All)
Pozíció:Named
Kötelező:False
Érték a csővezetékből:False
Érték a csővezetékből az ingatlan név szerint:False
Érték a maradék argumentumokból:False

-Name

Csak a megadott neveket vagy névmintákat tartalmazó szabályokat kapja meg. A helyettesítő karakterek használatát támogatjuk. Ha több nevet vagy mintát listáz, az összes olyan szabályt lekéri, amely megfelel bármelyik névmintának.

Paramétertulajdonságok

Típus:

String[]

Alapértelmezett érték:All rules
Támogató vadkártyák:True
Don't Show:False

Paraméterhalmazok

(All)
Pozíció:Named
Kötelező:False
Érték a csővezetékből:False
Érték a csővezetékből az ingatlan név szerint:False
Érték a maradék argumentumokból:False

-RecurseCustomRulePath

A CustomRulePath helyét rekurzív módon keresi meg az elérési út alkönyvtáraiban lévő fájlokban definiált szabályok hozzáadásához. Alapértelmezés szerint Get-ScriptAnalyzerRule csak az egyéni szabályokat adja hozzá a megadott elérési úthoz.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogató vadkártyák:False
Don't Show:False

Paraméterhalmazok

(All)
Pozíció:Named
Kötelező:False
Érték a csővezetékből:False
Érték a csővezetékből az ingatlan név szerint:False
Érték a maradék argumentumokból:False

-Severity

Csak a megadott súlyossági értékeket tartalmazó szabályokat kapja meg. Az érvényes értékek a következők:

  • Információ
  • Figyelmeztetés
  • Hiba

Paramétertulajdonságok

Típus:

String[]

Alapértelmezett érték:All rules
Támogató vadkártyák:False
Don't Show:False

Paraméterhalmazok

(All)
Pozíció:Named
Kötelező:False
Érték a csővezetékből:False
Érték a csővezetékből az ingatlan név szerint:False
Érték a maradék argumentumokból:False

CommonParameters

Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.

Bemenetek

None

Ehhez a parancsmaghoz nem lehet bemenő adatokat becsúszni.

Kimenetek

Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.RuleInfo

A RuleInfo objektum egy egyéni objektum, amelyet kifejezetten a Script Analyzer számára hoztak létre.