Invoke-ScriptAnalyzer

Szkript vagy modul kiértékelése a kiválasztott ajánlott eljárás szabályai alapján

Syntax

Path_SuppressedOnly (Alapértelmezett)

Invoke-ScriptAnalyzer
    [-Path] <string>
    [-CustomRulePath <string[]>]
    [-RecurseCustomRulePath]
    [-IncludeDefaultRules]
    [-ExcludeRule <string[]>]
    [-IncludeRule <string[]>]
    [-Severity <string[]>]
    [-Recurse]
    [-SuppressedOnly]
    [-Fix]
    [-EnableExit]
    [-Settings <Object>]
    [-SaveDscDependency]
    [-ReportSummary]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Path_IncludeSuppressed

Invoke-ScriptAnalyzer
    [-Path] <string>
    -IncludeSuppressed
    [-CustomRulePath <string[]>]
    [-RecurseCustomRulePath]
    [-IncludeDefaultRules]
    [-ExcludeRule <string[]>]
    [-IncludeRule <string[]>]
    [-Severity <string[]>]
    [-Recurse]
    [-Fix]
    [-EnableExit]
    [-Settings <Object>]
    [-SaveDscDependency]
    [-ReportSummary]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ScriptDefinition_IncludeSuppressed

Invoke-ScriptAnalyzer
    [-ScriptDefinition] <string>
    -IncludeSuppressed
    [-CustomRulePath <string[]>]
    [-RecurseCustomRulePath]
    [-IncludeDefaultRules]
    [-ExcludeRule <string[]>]
    [-IncludeRule <string[]>]
    [-Severity <string[]>]
    [-Recurse]
    [-EnableExit]
    [-Settings <Object>]
    [-SaveDscDependency]
    [-ReportSummary]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ScriptDefinition_SuppressedOnly

Invoke-ScriptAnalyzer
    [-ScriptDefinition] <string>
    [-CustomRulePath <string[]>]
    [-RecurseCustomRulePath]
    [-IncludeDefaultRules]
    [-ExcludeRule <string[]>]
    [-IncludeRule <string[]>]
    [-Severity <string[]>]
    [-Recurse]
    [-SuppressedOnly]
    [-EnableExit]
    [-Settings <Object>]
    [-SaveDscDependency]
    [-ReportSummary]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Invoke-ScriptAnalyzer az ajánlott eljárások szabályainak gyűjteménye alapján kiértékeli a szkripteket vagy modulfájlokat (.ps1, .psm1és .psd1 fájlokat), és visszaadja a szabálysértéseket képviselő objektumokat. A DSC-erőforrások elemzésére vonatkozó speciális szabályokat is tartalmaz.

Invoke-ScriptAnalyzer beépített szabályokkal rendelkezik. Alapértelmezés szerint minden szabályt használ. A IncludeRule és ExcludeRule paraméterekkel kiválaszthatja a kívánt szabályokat. A Get-ScriptAnalyzerRule parancsmaggal megvizsgálhatja és kijelölheti azokat a szabályokat, amelyeket bele szeretne foglalni vagy ki szeretne zárni a kiértékelésből.

A PowerShell-szkriptekben írt, testre szabott szabályokat is használhatja, vagy összeállításokban fordíthat a C# használatával. Egyéni szabályok is kiválaszthatók az IncludeRule és ExcludeRule paraméterekkel.

Az elemzésbe egy szabályt is belefoglalhat, de letilthatja a szabály kimenetét a kiválasztott függvények vagy szkriptek esetében. Ezt a funkciót csak akkor szabad használni, ha szükséges. A letiltott szabályok lekéréséhez futtassa a Invoke-ScriptAnalyzer a Letiltotton paraméterrel.

A CI-rendszerekben való használat esetén az EnableExit kilépési kóddal lép ki a rendszerhéjból, amely megegyezik a hibarekordok számával.

Példák

1. PÉLDA – Az összes szkriptelemző szabály futtatása szkripten

Invoke-ScriptAnalyzer -Path C:\Scripts\Get-LogData.ps1

2. PÉLDA – Az összes szkriptelemző szabály futtatása a Modulok könyvtárban lévő összes fájlon

Ez a példa a felhasználói .ps1 könyvtárban és annak alkönyvtáraiban lévő összes .psm1 és Modules fájlon futtatja az összes szkriptelemző szabályt.

Invoke-ScriptAnalyzer -Path $home\Documents\WindowsPowerShell\Modules -Recurse

3. PÉLDA – Egyetlen szabály futtatása egy modulon

Ez a példa csak a PSAvoidUsingPositionalParameters szabályt futtatja a PSDiagnostics modulmappában lévő fájlokon. Az ehhez hasonló parancsokkal megkeresheti egy adott szabálysértés összes példányát.

Invoke-ScriptAnalyzer -Path C:\Windows\System32\WindowsPowerShell\v1.0\Modules\PSDiagnostics -IncludeRule PSAvoidUsingPositionalParameters

4. PÉLDA – Az összes szabály futtatása a modulokon kettő kivételével

Ez a példa minden szabályt futtat, kivéve PSAvoidUsingCmdletAliases és PSAvoidUsingInternalURLS a .ps1 és .psm1 fájlokon a MyModules könyvtárban és annak alkönyvtáraiban.

$invokeScriptAnalyzerSplat = @{
    Path = 'C:\ps-test\MyModule'
    Recurse = $true
    ExcludeRule = 'PSAvoidUsingCmdletAliases', 'PSAvoidUsingInternalURLs'
}
Invoke-ScriptAnalyzer @invokeScriptAnalyzerSplat

5. PÉLDA – Szkriptelemző futtatása egyéni szabályokkal

Ez a példa a szkriptelemzőt Test-Script.ps1 futtatja a C:\CommunityAnalyzerRules elérési út standard szabályaival és szabályaival.

$invokeScriptAnalyzerSplat = @{
    Path = 'D:\test_scripts\Test-Script.ps1'
    CustomRulePath = 'C:\CommunityAnalyzerRules'
    IncludeDefaultRules = $true
}
Invoke-ScriptAnalyzer @invokeScriptAnalyzerSplat

6. PÉLDA – Csak a hiba súlyosságú és a PSDSC-forrásnévvel rendelkező szabályok futtatása

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

7. PÉLDA – Szabálysértések letiltása

Ez a példa bemutatja, hogyan tilthatja le a szabálysértések jelentését egy függvényben, és hogyan derítheti fel a letiltott szabálysértéseket.

A példa a SuppressMessageAttribute attribútummal tiltja le a PSUseSingularNouns és PSAvoidUsingCmdletAliases szabályokat a Get-Widgets függvényhez a Get-Widgets.ps1 szkriptben. Ezzel az attribútummal letilthatja a modulra, szkriptre, osztályra, függvényre, paraméterre vagy sorra vonatkozó szabályt.

Az első parancs futtatja a Script Analyzert a függvényt tartalmazó szkriptfájlban. A kimenet szabálysértést jelez. Annak ellenére, hogy több szabályt is megsértenek, a rendszer nem jelenti az elfojtott szabályt.

function Get-Widgets
{
    [CmdletBinding()]
    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")]
    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingCmdletAliases", "",
        Justification="Resolution in progress.")]
    Param()

    dir $PSHOME
    ...
}

Invoke-ScriptAnalyzer -Path .\Get-Widgets.ps1
RuleName                  Severity     FileName            Line  Message
--------                  --------     --------            ----  -------
PSProvideCommentHelp      Information  ManageProfiles.psm1 14    The cmdlet 'Get-Widget' does not have a help comment.
Invoke-ScriptAnalyzer -Path .\Get-Widgets.ps1 -SuppressedOnly
Rule Name                   Severity  File Name           Line  Justification
---------                   --------  ---------           ----  -------------
PSAvoidUsingCmdletAliases   Warning   ManageProfiles.psm1 21    Resolution in progress.
PSUseSingularNouns          Warning   ManageProfiles.psm1 14

A második parancs a SuppressedOnly paramétert használja a letiltott szkriptfájlban lévő szabályok megsértésének jelentésére.

8. PÉLDA – Szkriptfájlok elemzése profildefinícióval

Ebben a példában létrehozunk egy Szkriptelemző profilt, és az aktuális könyvtár ScriptAnalyzerProfile.txt fájljában mentjük. Invoke-ScriptAnalyzer futtatunk a BitLocker modulfájlokon. A Profil paraméter értéke a Szkriptelemző profil elérési útja.

# In .\ScriptAnalyzerProfile.txt
@{
    Severity = @('Error', 'Warning')
    IncludeRules = 'PSAvoid*'
    ExcludeRules = '*WriteHost'
}

Invoke-ScriptAnalyzer -Path $PSHOME\Modules\BitLocker -Settings .\ScriptAnalyzerProfile.txt

Ha ütköző paramétert ad meg a Invoke-ScriptAnalyzer parancsban, például -Severity Error, a parancsmag a profil értékét használja, és figyelmen kívül hagyja a paramétert.

9. PÉLDA – Sztringként tárolt szkript elemzése

Ez a példa a ScriptDefinition paramétert használja egy függvény parancssori elemzéséhez. A függvény sztringje idézőjelek közé van zárva.

Invoke-ScriptAnalyzer -ScriptDefinition "function Get-Widgets {Write-Host 'Hello'}"
RuleName               Severity     FileName   Line  Message
--------               --------     --------   ----  -------
PSAvoidUsingWriteHost  Warning                 1     Script definition uses Write-Host. Avoid using
                                                     Write-Host because it might not work in all hosts,
                                                     does not work when there is no host, and (prior
                                                     to PS 5.0) cannot be suppressed, captured, or
                                                     redirected. Instead, use Write-Output, Write-Verbose,
                                                     or Write-Information.
PSUseSingularNouns     Warning                 1     The cmdlet 'Get-Widgets' uses a plural noun. A
                                                     singular noun should be used instead.

A ScriptDefinition paraméter használatakor a DiagnosticRecord objektum FileName tulajdonsága $null.

Paraméterek

-Confirm

Megerősítést kér a parancsmag futtatása előtt.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False
Aliasok:Cf

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-CustomRulePath

Adja meg a szabályokat meghatározó fájl elérési útját, vagy egy olyan könyvtárat, amely szabályokat definiáló fájlokat tartalmaz. A helyettesítő karakterek támogatottak. Ha CustomRulePath van megadva, az elemzéshez csak a megadott elérési utakon található egyéni szabályokat használja a rendszer. Ha Invoke-ScriptAnalyzer nem talál szabályokat a fájlban, az előzetes értesítés nélkül futtatja a standard szabályokat.

Az elérési út alkönyvtáraiban definiált szabályok hozzáadásához használja a RecurseCustomRulePath paramétert. A beépített szabályok hozzáadásához adja hozzá az IncludeDefaultRules paramétert.

Paramétertulajdonságok

Típus:

String[]

Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:True
DontShow:False
Aliasok:TestreszabottSzabályÚtvonal

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-EnableExit

Az elemzés befejezésekor ez a paraméter kilép a PowerShell-munkamenetekből, és egy olyan kilépési kódot ad vissza, amely megegyezik a hibarekordok számával. Ez hasznos lehet a folyamatos integrációs (CI) folyamatokban.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-ExcludeRule

Kihagyja a megadott szabályokat a Szkriptelemző tesztből. A helyettesítő karakterek támogatottak.

Adja meg a szabálynevek vesszővel tagolt listáját, egy szabályneveket tartalmazó változót vagy egy szabályneveket lekérő parancsot. A szkriptelemző profilfájlban a kizárt szabályok listáját is megadhatja. Az egyéni szabályútvonalakban kizárhatja a szokásos szabályokat és szabályokat.

Ha kizár egy szabályt, a szabály nem fut az elérési út egyik fájlján sem. Ha ki szeretne zárni egy szabályt egy adott sorból, paraméterből, függvényből, szkriptből vagy osztályból, módosítsa az Elérési út paramétert, vagy tiltsa le a szabályt. A szabályok letiltásáról további információt a példákban talál.

Ha a ExcludeRule és IncludeRule gyűjteményekben is meg van adva szabály, a szabály ki lesz zárva.

Paramétertulajdonságok

Típus:

String[]

Alapértelmezett érték:All rules are included.
Támogatja a helyettesítő karaktereket:True
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-Fix

Kijavít bizonyos figyelmeztetéseket, amelyek javítást tartalmaznak a DiagnosticRecord.

A Javításhasználatakor az elemzés futtatása előtt Invoke-ScriptAnalyzer alkalmazza a javításokat. A paraméter használatakor győződjön meg arról, hogy biztonsági másolatot készít a fájlokról. Megpróbálja megőrizni a fájlkódolást, de még mindig vannak olyan esetek, amikor a kódolás változhat.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

Path_SuppressedOnly
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False
Path_IncludeSuppressed
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-IncludeDefaultRules

Az alapértelmezett szabályok és az egyéni szabályok meghívása.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-IncludeRule

Csak a megadott szabályokat futtatja a Szkriptelemző tesztben. Alapértelmezés szerint a PSScriptAnalyzer minden szabályt futtat.

Adja meg a szabálynevek vesszővel tagolt listáját, egy szabályneveket tartalmazó változót vagy egy szabályneveket lekérő parancsot. A helyettesítő karakterek támogatottak. A szabályneveket a Script Analyzer-profilfájlban is megadhatja.

Ha a CustomizedRulePath paramétert használja, ezzel a paraméter használatával szabványos szabályokat és szabályokat vehet fel az egyéni szabályútvonalakba.

Ha a ExcludeRule és IncludeRule gyűjteményekben is meg van adva szabály, a szabály ki lesz zárva.

A Súlyosság paraméter elsőbbséget élvez IncludeRule. Ha például súlyosságiError, IncludeRule nem használható Warning szabály belefoglalására.

Paramétertulajdonságok

Típus:

String[]

Alapértelmezett érték:All rules are included.
Támogatja a helyettesítő karaktereket:True
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-IncludeSuppressed

A kimenetbe belefoglalja a letiltott diagnosztikát.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

Path_IncludeSuppressed
Position:Named
Kötelező:True
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False
ScriptDefinition_IncludeSuppressed
Position:Named
Kötelező:True
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-Path

Megadja az elemezni kívánt szkriptek vagy modulok elérési útját. A helyettesítő karakterek támogatottak.

Adja meg egy szkript (.ps1) vagy modulfájl (.psm1) elérési útját, illetve egy szkripteket vagy modulokat tartalmazó könyvtárat. Ha a címtár más típusú fájlokat tartalmaz, a rendszer figyelmen kívül hagyja őket.

A megadott elérési út gyökérkönyvtárában nem szereplő fájlok elemzéséhez használjon helyettesítő karaktert (C:\Modules\MyModule\*) vagy a Recurse paramétert.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:True
DontShow:False
Aliasok:PSPath

Paraméterkészletek

Path_SuppressedOnly
Position:0
Kötelező:True
Folyamatból származó érték:True
Folyamatból származó érték tulajdonságnév alapján:True
Fennmaradó argumentumokból származó érték:False
Path_IncludeSuppressed
Position:0
Kötelező:True
Folyamatból származó érték:True
Folyamatból származó érték tulajdonságnév alapján:True
Fennmaradó argumentumokból származó érték:False

-Recurse

A szkriptelemzőt a Elérési út könyvtárban lévő fájlokon és az összes alkönyvtárban rekurzív módon futtatja.

A recurse csak az Elérési út paraméter értékére vonatkozik. A CustomRulePath rekurzív kereséséhez használja a RecurseCustomRulePath paramétert.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-RecurseCustomRulePath

Hozzáadja a CustomRulePath hely alkönyvtáraiban definiált szabályokat. Alapértelmezés szerint Invoke-ScriptAnalyzer csak a megadott fájlban vagy könyvtárban meghatározott egyéni szabályokat használja. A beépített szabályok belefoglalásához használja az IncludeDefaultRules paramétert.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-ReportSummary

Írja meg a gazdagép számára észlelt szabálysértések összegzését.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-SaveDscDependency

DSC-erőforrásfüggőségek feloldása.

Ha Invoke-ScriptAnalyzer ezzel a paraméterrel fut, a Import-DSCResource -ModuleName <somemodule>példányait keresi. Ha <somemodule> nem található a $env:PSModulePathkeresésével, Invoke-ScriptAnalyzer elemzési hibát ad vissza. Ezt a hibát az okozza, hogy a PowerShell-elemző nem tudja megtalálni a <somemodule>szimbólumát.

Ha Invoke-ScriptAnalyzer megtalálja a modult a PowerShell-katalógusban, letölti a hiányzó modult egy ideiglenes útvonalra. A rendszer ezután hozzáadja az ideiglenes elérési utat a $env:PSModulePath a vizsgálat időtartamára. Az ideiglenes hely $LOCALAPPDATA/PSScriptAnalyzer/TempModuleDirtalálható.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-ScriptDefinition

A sztringben lévő parancsokon, függvényeken vagy kifejezéseken futtatja az elemzést. Ezzel a funkcióval utasításokat, kifejezéseket és függvényeket elemezhet a szkriptkörnyezetétől függetlenül.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

ScriptDefinition_IncludeSuppressed
Position:0
Kötelező:True
Folyamatból származó érték:True
Folyamatból származó érték tulajdonságnév alapján:True
Fennmaradó argumentumokból származó érték:False
ScriptDefinition_SuppressedOnly
Position:0
Kötelező:True
Folyamatból származó érték:True
Folyamatból származó érték tulajdonságnév alapján:True
Fennmaradó argumentumokból származó érték:False

-Settings

Egy felhasználó által definiált profilt vagy kivonatoló objektumot tartalmazó fájl elérési útja, amely a ScriptAnalyzer beállításait tartalmazza.

Futtatja Invoke-ScriptAnalyzer a fájlban vagy kivonatolóban megadott paraméterekkel és értékekkel.

Ha a fájl vagy kivonatoló elérési útja vagy tartalma érvénytelen, a rendszer figyelmen kívül hagyja. A profil paraméterei és értékei elsőbbséget élveznek a parancssorban megadott paraméterekkel és értékekkel szemben.

A Szkriptelemző profilfájl olyan szövegfájl, amely egy kivonatolót tartalmaz az alábbi kulcsok közül egy vagy többkel:

  • CustomRulePath
  • Kizárási szabályok
  • IncludeDefaultRules
  • IncludeRules
  • RecurseCustomRulePath
  • Szabályok
  • Súlyosság

A profil kulcsait és értékeit a rendszer úgy értelmezi, mintha a Invoke-ScriptAnalyzerszabványos paraméterei és értékei lennének, hasonlóan a szóráshoz. További információkért tekintse meg a következőket: about_Splatting.

Paramétertulajdonságok

Típus:Object
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False
Aliasok:Profil

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-Severity

Miután futtatta a Szkriptelemzőt az összes szabálysal, ez a paraméter a megadott súlyosságú szabálysértéseket választja ki.

Az érvényes értékek a következők:

  • Hiba
  • Figyelmeztetés
  • Információ
  • ParseError

Megadhatsz egy vagy több súlyossági értéket.

A paraméter csak az összes szabály futtatása után szűrői ki a szabálysértés kimenetét. Nem szűri, mely szabályokat futtatják. A szabályok hatékony szűréséhez a Get-ScriptAnalyzerRule használatával válassza ki a futtatni kívánt szabályokat.

Paramétertulajdonságok

Típus:

String[]

Alapértelmezett érték:All rule violations
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-SuppressedOnly

Csak a letiltott szabályokra vonatkozó szabálysértéseket adja vissza.

Egy SuppressedRecord objektumot ad vissza (Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.SuppressedRecord).

Egy szabály letiltásához használja a SuppressMessageAttribute. Segítségért tekintse meg a példákat.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

Path_SuppressedOnly
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False
ScriptDefinition_SuppressedOnly
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-WhatIf

Megjeleníti, mi történne, ha a parancsmag futna. A parancsmag nem fut.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False
Aliasok:Wi

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték: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.

Bevitelek

None

Ehhez a parancsmaghoz nem csövezhet be bemenetet.

Kimenetek

Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.DiagnosticRecord

Alapértelmezés szerint a Invoke-ScriptAnalyzer egy DiagnosticRecord objektumot ad vissza minden szabálysértéshez.

Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.SuppressedRecord

Ha a SuppressedOnly paramétert használja, Invoke-ScriptAnalyzer ehelyett egy Letiltott objektumot ad vissza.