Invoke-ScriptAnalyzer
Évalue un script ou un module en fonction des règles de bonnes pratiques sélectionnées
Syntaxe
Path_SuppressedOnly (Par défaut)
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 évalue les scripts ou les fichiers de module (.ps1, .psm1et .psd1 fichiers) en fonction d’une collection de règles de bonne pratique et retourne des objets qui représentent des violations de règle. Il inclut également des règles spéciales pour analyser les ressources DSC.
Invoke-ScriptAnalyzer est fourni avec un ensemble de règles intégrées. Par défaut, elle utilise toutes les règles. Vous pouvez utiliser les paramètres IncludeRule et ExcludeRule pour sélectionner les règles souhaitées. Vous pouvez utiliser l’applet de commande Get-ScriptAnalyzerRule pour examiner et sélectionner les règles que vous souhaitez inclure ou exclure de l’évaluation.
Vous pouvez également utiliser des règles personnalisées que vous écrivez dans des scripts PowerShell ou compiler dans des assemblys à l’aide de C#. Les règles personnalisées peuvent également être sélectionnées à l’aide des paramètres IncludeRule includeRule et ExcludeRule.
Vous pouvez également inclure une règle dans l’analyse, mais supprimer la sortie de cette règle pour les fonctions ou les scripts sélectionnés. Cette fonctionnalité ne doit être utilisée que si nécessaire. Pour obtenir des règles qui ont été supprimées, exécutez Invoke-ScriptAnalyzer avec le paramètre SuppressedOnly.
Pour une utilisation dans les systèmes CI, l'EnableExit quitte l’interpréteur de commandes avec un code de sortie égal au nombre d’enregistrements d’erreur.
Exemples
EXEMPLE 1 - Exécuter toutes les règles d’analyseur de script sur un script
Invoke-ScriptAnalyzer -Path C:\Scripts\Get-LogData.ps1
EXEMPLE 2 - Exécuter toutes les règles d’analyseur de script sur tous les fichiers du répertoire Modules
Cet exemple exécute toutes les règles d’analyseur de script sur tous les fichiers .ps1 et .psm1 dans votre répertoire Modules basé sur l’utilisateur et ses sous-répertoires.
Invoke-ScriptAnalyzer -Path $home\Documents\WindowsPowerShell\Modules -Recurse
EXEMPLE 3 - Exécuter une règle unique sur un module
Cet exemple exécute uniquement la règle PSAvoidUsingPositionalParameters sur les fichiers du dossier du module PSDiagnostics. Vous pouvez utiliser une commande comme celle-ci pour rechercher toutes les instances d’une violation de règle particulière.
Invoke-ScriptAnalyzer -Path C:\Windows\System32\WindowsPowerShell\v1.0\Modules\PSDiagnostics -IncludeRule PSAvoidUsingPositionalParameters
EXEMPLE 4 - Exécuter toutes les règles à l’exception de deux sur vos modules
Cet exemple exécute toutes les règles à l’exception de PSAvoidUsingCmdletAliases et PSAvoidUsingInternalURLs sur les fichiers .ps1 et .psm1 dans le répertoire MyModules et dans ses sous-répertoires.
Invoke-ScriptAnalyzer -Path C:\ps-test\MyModule -Recurse -ExcludeRule PSAvoidUsingCmdletAliases, PSAvoidUsingInternalURLs
EXEMPLE 5 - Exécuter l’analyseur de script avec des règles personnalisées
Cet exemple exécute Script Analyzer sur Test-Script.ps1 avec les règles et règles standard dans le chemin d’accès C:\CommunityAnalyzerRules.
Invoke-ScriptAnalyzer -Path D:\test_scripts\Test-Script.ps1 -CustomRulePath C:\CommunityAnalyzerRules -IncludeDefaultRules
EXEMPLE 6 : Exécutez uniquement les règles qui sont de gravité d’erreur et qui ont le nom de la source PSDSC
$DSCError = Get-ScriptAnalyzerRule -Severity Error | Where SourceName -eq PSDSC
$Path = "$home\Documents\WindowsPowerShell\Modules\MyDSCModule"
Invoke-ScriptAnalyzerRule -Path $Path -IncludeRule $DSCError -Recurse
EXEMPLE 7 - Suppression des violations de règles
Cet exemple montre comment supprimer la création de rapports de violations de règles dans une fonction et comment découvrir les violations de règles supprimées.
L’exemple utilise l’attribut SuppressMessageAttribute pour supprimer les règles PSUseSingularNouns et PSAvoidUsingCmdletAliases pour la fonction Get-Widgets dans le script Get-Widgets.ps1.
Vous pouvez utiliser cet attribut pour supprimer une règle pour un module, un script, une classe, une fonction, un paramètre ou une ligne.
La première commande exécute Script Analyzer sur le fichier de script contenant la fonction. La sortie signale une violation de règle. Même si d’autres règles sont violées, aucune règle supprimée n’est signalée.
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 ManageProf 14 The cmdlet 'Get-Widget' does not have a help comment.
iles.psm1
Invoke-ScriptAnalyzer -Path .\Get-Widgets.ps1 -SuppressedOnly
Rule Name Severity File Name Line Justification
--------- -------- --------- ---- -------------
PSAvoidUsingCmdletAliases Warning ManageProf 21 Resolution in progress.
iles.psm1
PSUseSingularNouns Warning ManageProf 14
iles.psm1
La deuxième commande utilise le paramètre SuppressedOnly pour signaler les violations des règles qui sont supprimées du fichier de script.
EXEMPLE 8 - Analyser des fichiers de script à l’aide d’une définition de profil
Dans cet exemple, nous créons un profil Script Analyzer et l’enregistrez dans le fichier ScriptAnalyzerProfile.txt dans le répertoire actif. Nous exécutons Invoke-ScriptAnalyzer sur les fichiers de module BitLocker. La valeur du paramètre Profile est le chemin d’accès au profil Script Analyzer.
# In .\ScriptAnalyzerProfile.txt
@{
Severity = @('Error', 'Warning')
IncludeRules = 'PSAvoid*'
ExcludeRules = '*WriteHost'
}
Invoke-ScriptAnalyzer -Path $pshome\Modules\BitLocker -Settings .\ScriptAnalyzerProfile.txt
Si vous incluez un paramètre en conflit dans la commande Invoke-ScriptAnalyzer, telle que -Severity Error, l’applet de commande utilise la valeur de profil et ignore le paramètre.
EXEMPLE 9 - Analyser un script stocké sous forme de chaîne
Cet exemple utilise le paramètre ScriptDefinition pour analyser une fonction sur la ligne de commande. La chaîne de fonction est placée entre guillemets.
Invoke-ScriptAnalyzer -ScriptDefinition "function Get-Widgets {Write-Host 'Hello'}"
RuleName Severity FileName Line Message
-------- -------- -------- ---- -------
PSAvoidUsingWriteHost Warning 1 Script
because
there i
suppres
Write-O
PSUseSingularNouns Warning 1 The cmd
noun sh
Lorsque vous utilisez le paramètre ScriptDefinition, la propriété FileName de l’objet DiagnosticRecord est $null.
Paramètres
-Confirm
Vous invite à confirmer avant d’exécuter l’applet de commande.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | cf |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-CustomRulePath
Entrez le chemin d’accès à un fichier qui définit des règles ou un répertoire qui contient des fichiers qui définissent des règles.
Les caractères génériques sont pris en charge. Lorsque CustomRulePath est spécifié, seules les règles personnalisées trouvées dans les chemins spécifiés sont utilisées pour l’analyse. Si Invoke-ScriptAnalyzer ne trouve pas de règles dans le , il exécute les règles standard sans préavis.
Pour ajouter des règles définies dans les sous-répertoires du chemin d’accès, utilisez le paramètre RecurseCustomRulePath. Pour inclure les règles intégrées, ajoutez le paramètre IncludeDefaultRules.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | True |
| DontShow: | False |
| Alias: | CustomizedRulePath |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-EnableExit
Une fois l’analyse terminée, ce paramètre quitte les sessions PowerShell et retourne un code de sortie égal au nombre d’enregistrements d’erreur. Cela peut être utile dans le pipeline d’intégration continue (CI).
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-ExcludeRule
Omettez les règles spécifiées du test Script Analyzer. Les caractères génériques sont pris en charge.
Entrez une liste séparée par des virgules de noms de règles, une variable qui contient des noms de règles ou une commande qui obtient des noms de règles. Vous pouvez également spécifier une liste de règles exclues dans un fichier de profil Script Analyzer. Vous pouvez exclure des règles et des règles standard dans un chemin d’accès de règle personnalisé.
Lorsque vous excluez une règle, la règle ne s’exécute pas sur les fichiers du chemin d’accès. Pour exclure une règle d’une ligne, d’un paramètre, d’une fonction, d’un script ou d’une classe particulière, ajustez le paramètre Path ou supprimez la règle. Pour plus d’informations sur la suppression d’une règle, consultez les exemples.
Si une règle est spécifiée dans les collections ExcludeRule et IncludeRule collections, la règle est exclue.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | All rules are included. |
| Prend en charge les caractères génériques: | True |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Fix
Corrige certains avertissements qui contiennent un correctif dans leur DiagnosticRecord.
Lorsque vous avez utilisé correctif, Invoke-ScriptAnalyzer applique les correctifs avant d’exécuter l’analyse. Vérifiez que vous disposez d’une sauvegarde de vos fichiers lors de l’utilisation de ce paramètre. Il tente de conserver l’encodage de fichier, mais il existe toujours certains cas où l’encodage peut changer.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
Path_SuppressedOnly
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
Path_IncludeSuppressed
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-IncludeDefaultRules
Appelez des règles par défaut avec des règles personnalisées.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-IncludeRule
Exécute uniquement les règles spécifiées dans le test Script Analyzer. Par défaut, PSScriptAnalyzer exécute toutes les règles.
Entrez une liste séparée par des virgules de noms de règles, une variable qui contient des noms de règles ou une commande qui obtient des noms de règles. Les caractères génériques sont pris en charge. Vous pouvez également spécifier des noms de règles dans un fichier de profil Script Analyzer.
Lorsque vous utilisez le paramètre CustomRulePath, vous pouvez utiliser ce paramètre pour inclure des règles et des règles standard dans les chemins d’accès aux règles personnalisées.
Si une règle est spécifiée dans les collections ExcludeRule et IncludeRule collections, la règle est exclue.
Le paramètre gravité est prioritaire sur IncludeRule . Par exemple, si de gravité est Error, vous ne pouvez pas utiliser includeRule pour inclure une règle de Warning.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | All rules are included. |
| Prend en charge les caractères génériques: | True |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-IncludeSuppressed
Incluez les diagnostics supprimés dans la sortie.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
Path_IncludeSuppressed
| Position: | Named |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
ScriptDefinition_IncludeSuppressed
| Position: | Named |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Path
Spécifie le chemin d’accès aux scripts ou au module à analyser. Les caractères génériques sont pris en charge.
Entrez le chemin d’accès à un script (.ps1) ou un fichier de module (.psm1) ou à un répertoire qui contient des scripts ou des modules. Si le répertoire contient d’autres types de fichiers, ils sont ignorés.
Pour analyser les fichiers qui ne se trouvent pas dans le répertoire racine du chemin spécifié, utilisez un caractère générique (C:\Modules\MyModule\*) ou le paramètre Recurse.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | True |
| DontShow: | False |
| Alias: | PSPath |
Jeux de paramètres
Path_SuppressedOnly
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
Path_IncludeSuppressed
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-Recurse
Exécute l’analyseur de script sur les fichiers du répertoire Path et tous les sous-répertoires de manière récursive.
La récursivité s’applique uniquement à la valeur du paramètre Path. Pour rechercher CustomRulePath de manière récursive, utilisez le paramètre RecurseCustomRulePath.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-RecurseCustomRulePath
Ajoute des règles définies dans les sous-répertoires de l’emplacement CustomRulePath. Par défaut, Invoke-ScriptAnalyzer utilise uniquement les règles personnalisées définies dans le fichier ou le répertoire spécifié. Pour inclure les règles intégrées, utilisez le paramètre IncludeDefaultRules.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-ReportSummary
Écrivez un résumé des violations trouvées sur l’hôte.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-SaveDscDependency
Résolvez les dépendances de ressources DSC.
Lorsque Invoke-ScriptAnalyzer est exécuté avec ce paramètre, il recherche des instances de Import-DSCResource -ModuleName <somemodule>. Si <somemodule> est introuvable en recherchant le $env:PSModulePath, Invoke-ScriptAnalyzer retourne une erreur d’analyse. Cette erreur est due à l’incapacité de l’analyseur PowerShell à trouver le symbole de <somemodule>.
Si Invoke-ScriptAnalyzer trouve le module dans PowerShell Gallery, il télécharge le module manquant dans un chemin temporaire. Le chemin temporaire est ensuite ajouté à $env:PSModulePath pendant la durée de l’analyse.
L’emplacement temporaire se trouve dans $LOCALAPPDATA/PSScriptAnalyzer/TempModuleDir.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-ScriptDefinition
Exécute l’analyse sur des commandes, des fonctions ou des expressions dans une chaîne. Vous pouvez utiliser cette fonctionnalité pour analyser des instructions, des expressions et des fonctions, indépendamment de leur contexte de script.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
ScriptDefinition_IncludeSuppressed
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
ScriptDefinition_SuppressedOnly
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-Settings
Chemin d’accès à un fichier contenant un profil défini par l’utilisateur ou un objet de table de hachage contenant des paramètres pour ScriptAnalyzer.
Exécute Invoke-ScriptAnalyzer avec les paramètres et les valeurs spécifiés dans le fichier ou la table de hachage.
Si le chemin d’accès ou le contenu du fichier ou de la table de hachage n’est pas valide, il est ignoré. Les paramètres et les valeurs du profil sont prioritaires sur le même paramètre et les mêmes valeurs spécifiés à la ligne de commande.
Un fichier de profil Script Analyzer est un fichier texte qui contient une table de hachage avec une ou plusieurs des clés suivantes :
- CustomRulePath
- ExcludeRules
- IncludeDefaultRules
- IncludeRules
- RecurseCustomRulePath
- Règles
- Sévérité
Les clés et les valeurs du profil sont interprétées comme s’il s’agissait de paramètres et de valeurs standard de Invoke-ScriptAnalyzer, similaires à la mise en forme. Pour plus d'informations, consultez À propos de la projection.
Propriétés du paramètre
| Type: | Object |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | Profil |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Severity
Après avoir exécuté Script Analyzer avec toutes les règles, ce paramètre sélectionne les violations de règles avec la gravité spécifiée.
Les valeurs valides sont les suivantes :
- Erreur
- Avertissement
- Information.
Vous pouvez spécifier une ou plusieurs valeurs de gravité.
Le paramètre filtre les violations des règles uniquement après l’exécution de toutes les règles. Pour filtrer efficacement les règles, utilisez Get-ScriptAnalyzerRule pour sélectionner les règles que vous souhaitez exécuter.
Le paramètre gravité est prioritaire sur IncludeRule . Par exemple, si de gravité est Error, vous ne pouvez pas utiliser includeRule pour inclure une règle de Warning.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | All rule violations |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-SuppressedOnly
Retourne des violations uniquement pour les règles qui sont supprimées.
Renvoie un objet SuppressedRecord (Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.SuppressedRecord).
Pour supprimer une règle, utilisez le SuppressMessageAttribute. Pour obtenir de l’aide, consultez les exemples.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
Path_SuppressedOnly
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
ScriptDefinition_SuppressedOnly
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-WhatIf
Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | Wi |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
Entrées
None
Vous ne pouvez pas diriger d'entrée vers cette applet de commande.
Sorties
Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.DiagnosticRecord
Par défaut, Invoke-ScriptAnalyzer retourne un objet DiagnosticRecord pour chaque violation de règle.
Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.SuppressedRecord
Si vous utilisez le paramètre suppressedOnly, Invoke-ScriptAnalyzer retourne à la place un objet SuppressedRecord.