Get-Help

  • Référence
Module:
Microsoft.PowerShell.Core

Affiche des informations sur les commandes et les concepts PowerShell.

Syntax

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Full]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Detailed
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Examples
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Parameter <String[]>
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -Online
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -ShowWindow
   [<CommonParameters>]

Description

L’applet Get-Help de commande affiche des informations sur les concepts et commandes PowerShell, notamment les applets de commande, les fonctions, les commandes CIM (Common Information Model), les flux de travail, les fournisseurs, les alias et les scripts.

Pour obtenir de l’aide pour une applet de commande PowerShell, tapez Get-Help le nom de l’applet de commande, par exemple : Get-Help Get-Process.

Les articles d’aide conceptuelle dans PowerShell commencent par about_, tels que about_Comparison_Operators. Pour afficher tous les articles about_ , tapez Get-Help about_*. Pour afficher un article particulier, tapez Get-Help about_<article-name>, par Get-Help about_Comparison_Operatorsexemple .

Pour obtenir de l’aide pour un fournisseur PowerShell, tapez Get-Help le nom du fournisseur. Par exemple, pour obtenir de l’aide pour le fournisseur de certificats, tapez Get-Help Certificate.

Vous pouvez également taper help ou manafficher un écran de texte à la fois. Ou, <cmdlet-name> -?c’est identique à Get-Help, mais fonctionne uniquement pour les applets de commande.

Get-Help obtient le contenu d’aide qu’il affiche à partir de fichiers d’aide sur votre ordinateur. Sans les fichiers d’aide, Get-Help affiche uniquement des informations de base sur les applets de commande. Certains modules PowerShell incluent des fichiers d’aide. À compter de PowerShell 3.0, les modules fournis avec le système d’exploitation Windows n’incluent pas de fichiers d’aide. Pour télécharger ou mettre à jour les fichiers d’aide d’un module dans PowerShell 3.0, utilisez l’applet Update-Help de commande.

Vous pouvez également afficher les documents d’aide PowerShell en ligne. Pour obtenir la version en ligne d’un fichier d’aide, utilisez le paramètre Online , par exemple : Get-Help Get-Process -Online.

Si vous tapez Get-Help suivi du nom exact d’un article d’aide ou d’un mot unique pour un article d’aide, Get-Help affiche le contenu de l’article. Si vous spécifiez le nom exact d’un alias de commande, Get-Help affiche l’aide de la commande d’origine. Si vous entrez un mot ou un modèle de mot qui apparaît dans plusieurs titres d’article d’aide, Get-Help affiche une liste des titres correspondants. Si vous entrez un texte qui n’apparaît dans aucun titre d’article d’aide, Get-Help affiche une liste d’articles qui incluent ce texte dans leur contenu.

Get-Help peut obtenir des articles d’aide pour toutes les langues et paramètres régionaux pris en charge. Get-Helprecherche d’abord les fichiers d’aide dans les paramètres régionaux définis pour Windows, puis dans les paramètres régionaux parents, tels que pt-BR, puis dans les paramètres régionaux de secours. À compter de PowerShell 3.0, s’il Get-Help ne trouve pas d’aide dans les paramètres régionaux de secours, il recherche des articles d’aide en anglais, en-US, avant de renvoyer un message d’erreur ou d’afficher l’aide générée automatiquement.

Pour plus d’informations sur les symboles qui Get-Help s’affichent dans le diagramme de syntaxe de commande, consultez about_Command_Syntax. Pour plus d’informations sur les attributs de paramètre, tels que Obligatoire et Position, consultez about_Parameters.

Remarque

Dans PowerShell 3.0 et PowerShell 4.0, Get-Help vous ne trouverez pas d’articles à propos des modules, sauf si le module est importé dans la session active. Pour obtenir des articles About dans un module, importez le module à l’aide de l’applet Import-Module de commande ou exécutez une applet de commande incluse dans le module.

À compter de PSReadLine v2.2.2, le module est fourni avec deux fonctions qui fournissent un accès rapide pour vous aider pendant que vous tapez une commande sur la ligne de commande. L’aide s’affiche dans le terminal dans une autre mémoire tampon d’écran avec pagination.

Lorsque vous appuyez sur la touche F1 , la fonction PSReadLineShowCommandHelp appelle Get-Help -Full le nom de l’applet de commande le plus proche à gauche du curseur. Lorsque le curseur est immédiatement à gauche d’un paramètre, la fonction passe à la description de ce paramètre dans la rubrique d’aide complète. Lorsque vous appuyez sur Q pour quitter la vue d’aide, vous êtes retourné à la ligne de commande à la même position de curseur pour continuer à taper la commande.

Lorsque vous utilisez la combinaison de touches Alt+h, la fonction PSReadLineShowParameterHelp affiche des informations d’aide pour le paramètre immédiatement à gauche du curseur. Le texte d’aide s’affiche sous la ligne de commande. Cela vous permet de voir la description du paramètre et de continuer à taper votre commande.

Pour plus d’informations, consultez Utilisation de l’aide dynamique.

Exemples

Exemple 1 : Afficher des informations d’aide de base sur une applet de commande

Ces exemples affichent des informations d’aide de base sur l’applet de Format-Table commande.

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> est la syntaxe la plus simple et par défaut de l’applet de Get-Help commande. Vous pouvez omettre le paramètre Name .

La syntaxe <cmdlet-name> -? fonctionne uniquement pour les applets de commande.

Exemple 2 : Afficher des informations de base d’une page à la fois

Ces exemples affichent des informations d’aide de base sur l’applet de commande une page à la Format-Table fois.

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help est une fonction qui exécute l’applet Get-Help de commande en interne et affiche le résultat d’une page à la fois.

man est un alias pour la help fonction.

Get-Help Format-Table envoie l’objet vers le bas du pipeline. Out-Host -Paging reçoit la sortie du pipeline et l’affiche une page à la fois. Pour plus d’informations, consultez Out-Host.

Exemple 3 : Afficher plus d’informations pour une applet de commande

Ces exemples affichent des informations d’aide plus détaillées sur l’applet de Format-Table commande.

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

Le paramètre Détaillé affiche la vue détaillée de l’article d’aide qui inclut des descriptions et des exemples de paramètres.

Le paramètre Full affiche l’affichage complet de l’article d’aide qui inclut des descriptions de paramètres, des exemples, des types d’objets d’entrée et de sortie, ainsi que des notes supplémentaires.

Les paramètres Détaillé et Complet sont efficaces uniquement pour les commandes sur utilisant des fichiers d’aide installés sur l’ordinateur. Les paramètres ne sont pas efficaces pour les articles d’aide conceptuels (about_).

Exemple 4 : Afficher les parties sélectionnées d’une applet de commande à l’aide de paramètres

Ces exemples affichent les parties sélectionnées de l’aide de l’applet Format-Table de commande.

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

Le paramètre Examples affiche les sections NAME et SYNOPSIS du fichier d’aide, ainsi que tous les exemples. Vous ne pouvez pas spécifier de numéro d’exemple, car le paramètre Examples est un paramètre switch.

Le paramètre Paramètre affiche uniquement les descriptions des paramètres spécifiés. Si vous spécifiez uniquement le caractère astérisque (*) wild carte, il affiche les descriptions de tous les paramètres. Lorsque Le paramètre spécifie un nom de paramètre tel que GroupBy, des informations sur ce paramètre sont affichées.

Ces paramètres ne sont pas efficaces pour les articles d’aide conceptuels (about_).

Exemple 5 : Afficher la version en ligne de l’aide

Cet exemple montre comment afficher la version en ligne de l’article d’aide de l’applet Format-Table de commande dans votre navigateur web par défaut.

Get-Help Format-Table -Online

Exemple 6 : Afficher l’aide sur le système d’aide

L’applet Get-Help de commande sans paramètres affiche des informations sur le système d’aide PowerShell.

Get-Help

Exemple 7 : Afficher les articles d’aide disponibles

Cet exemple affiche la liste de tous les articles d’aide disponibles sur votre ordinateur.

Get-Help *

Exemple 8 : Afficher une liste d’articles conceptuels

Cet exemple montre comment afficher la liste des articles conceptuels inclus dans l’aide de PowerShell. Tous ces articles commencent par les caractères about_. Pour afficher un fichier d’aide particulier, tapez Get-Help \<about_article-name\>, par exemple Get-Help about_Signing.

Seuls les articles conceptuels sur utilisant des fichiers d’aide installés sur votre ordinateur sont affichés. Pour plus d’informations sur le téléchargement et l’installation de fichiers d’aide dans PowerShell 3.0, consultez Update-Help.

Get-Help about_*

Exemple 9 : Rechercher un mot dans l’aide de l’applet de commande

Cet exemple montre comment rechercher un mot dans un article d’aide sur l’applet de commande.

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Help utilise le paramètre Full pour obtenir des informations d’aide pour Add-Member. L’objet MamlCommandHelpInfo est envoyé vers le bas du pipeline. Out-String utilise le paramètre Stream pour convertir l’objet en chaîne. Select-String utilise le paramètre Pattern pour rechercher la chaîne de Clixml.

Exemple 10 : Afficher une liste d’articles incluant un mot

Cet exemple affiche une liste d’articles qui incluent la communication à distance du mot.

Lorsque vous entrez un mot qui n’apparaît dans aucun titre d’article, Get-Help affiche une liste d’articles qui incluent ce mot.

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

Exemple 11 : Afficher l’aide spécifique au fournisseur

Cet exemple montre deux façons d’obtenir l’aide spécifique au fournisseur pour Get-Item. Ces commandes obtiennent de l’aide qui explique comment utiliser l’applet Get-Item de commande dans le nœud DataCollection du fournisseur PowerShell SQL Server.

Le premier exemple utilise le Get-Helpparamètre Path pour spécifier le chemin d’accès du fournisseur SQL Server. Étant donné que le chemin d’accès du fournisseur est spécifié, vous pouvez exécuter la commande à partir de n’importe quel emplacement de chemin d’accès.

Le deuxième exemple utilise Set-Location pour accéder au chemin du fournisseur SQL Server. À partir de cet emplacement, le paramètre Path n’est pas nécessaire pour Get-Help obtenir l’aide spécifique au fournisseur.

Get-Help Get-Item -Path SQLSERVER:\DataCollection

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Set-Location SQLSERVER:\DataCollection
SQLSERVER:\DataCollection> Get-Help Get-Item

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Exemple 12 : Afficher l’aide d’un script

Cet exemple obtient de l’aide pour le MyScript.ps1 script. Pour plus d’informations sur l’écriture d’aide pour vos fonctions et scripts, consultez about_Comment_Based_Help.

Get-Help -Name C:\PS-Test\MyScript.ps1

Paramètres

-Category

Affiche l'aide uniquement des éléments de la catégorie spécifiée et de leurs alias. Les articles conceptuels se trouvent dans la catégorie HelpFile .

Les valeurs acceptables pour ce paramètre sont les suivantes :

  • Alias
  • Applet de commande
  • Fournisseur
  • Général
  • FAQ
  • Glossaire
  • HelpFile
  • ScriptCommand
  • Fonction
  • Filtrer
  • ExternalScript
  • Tous
  • DefaultHelp
  • Workflow
  • DscResource
  • Classe
  • Configuration
Type:String[]
Accepted values:Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Component

Affiche les commandes avec la valeur de composant spécifiée, telle qu’Exchange. Entrez un nom de composant. Les caractères génériques sont autorisés. Ce paramètre n’a aucun effet sur les affichages d’aide conceptuelle (About_).

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Detailed

Ajoute la description des paramètre et les exemples à l'affichage de l'aide de base. Ce paramètre est effectif uniquement lorsque les fichiers d’aide sont installés sur l’ordinateur. Il n’a aucun effet sur les affichages d’aide conceptuelle (About_).

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Examples

Affiche uniquement le nom, le résumé et les exemples. Ce paramètre est effectif uniquement lorsque les fichiers d’aide sont installés sur l’ordinateur. Il n’a aucun effet sur les affichages d’aide conceptuelle (About_).

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Full

Affiche l’intégralité de l’article d’aide pour une applet de commande. Complet inclut des descriptions et des attributs de paramètre, des exemples, des types d’objets d’entrée et de sortie, ainsi que des notes supplémentaires.

Ce paramètre est effectif uniquement lorsque les fichiers d’aide sont installés sur l’ordinateur. Il n’a aucun effet sur les affichages d’aide conceptuelle (About_).

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Functionality

Affiche l'aide pour des éléments ayant la fonctionnalité spécifiée. Entrez la fonctionnalité. Les caractères génériques sont autorisés. Ce paramètre n’a aucun effet sur les affichages d’aide conceptuelle (About_).

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Name

Obtient de l'aide sur la commande ou le concept spécifié. Entrez le nom d’une applet de commande, d’une fonction, d’un fournisseur, d’un script ou d’un flux de travail, tel que Get-Member, un nom d’article conceptuel, tel qu’un about_Objectsalias, tel que ls. Les caractères génériques carte sont autorisés dans les noms d’applet de commande et de fournisseur, mais vous ne pouvez pas utiliser de caractères génériques carte pour rechercher les noms des articles d’aide de fonction et d’aide de script.

Pour obtenir de l’aide pour un script qui n’est pas situé dans un chemin d’accès répertorié dans la $env:Path variable d’environnement, tapez le chemin d’accès et le nom du fichier du script.

Si vous entrez le nom exact d’un article d’aide, Get-Help affiche le contenu de l’article.

Si vous entrez un mot ou un modèle de mot qui apparaît dans plusieurs titres d’article d’aide, Get-Help affiche une liste des titres correspondants.

Si vous entrez un texte qui ne correspond à aucun titre d’article d’aide, Get-Help affiche une liste d’articles qui incluent ce texte dans leur contenu.

Les noms des articles conceptuels, tels que about_Objects, doivent être entrés en anglais, même dans les versions non anglaises de PowerShell.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Online

Affiche la version en ligne d’un article d’aide dans le navigateur par défaut. Ce paramètre est valide uniquement pour les articles d’aide sur l’applet de commande, la fonction, le flux de travail et le script. Vous ne pouvez pas utiliser le paramètre Online dans Get-Help une session à distance.

Pour plus d’informations sur la prise en charge de cette fonctionnalité dans les articles d’aide que vous écrivez, consultez about_Comment_Based_Help, ainsi que l’aide en ligne de prise en charge et l’écriture d’aide pour les applets de commande PowerShell.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Parameter

Affiche uniquement les descriptions détaillées des paramètres spécifiés. Les caractères génériques sont autorisés. Ce paramètre n’a aucun effet sur les affichages d’aide conceptuelle (About_).

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

-Path

Obtient l'aide qui explique le fonctionnement de l'applet de commande dans le chemin d'accès du fournisseur spécifié. Entrez un chemin d’accès du fournisseur PowerShell.

Ce paramètre obtient une version personnalisée d’un article d’aide sur l’applet de commande qui explique le fonctionnement de l’applet de commande dans le chemin d’accès du fournisseur PowerShell spécifié. Ce paramètre est efficace uniquement pour obtenir de l’aide sur une applet de commande de fournisseur et uniquement lorsque le fournisseur inclut une version personnalisée de l’article d’aide de l’applet de commande du fournisseur dans son fichier d’aide. Pour utiliser ce paramètre, installez le fichier d'aide du module qui inclut le fournisseur.

Pour afficher l’aide de l’applet de commande personnalisée pour un chemin d’accès du fournisseur, accédez à l’emplacement du chemin du fournisseur et entrez une Get-Help commande ou, à partir de n’importe quel emplacement de chemin d’accès, utilisez le paramètre Path pour Get-Help spécifier le chemin d’accès du fournisseur. Vous pouvez également trouver de l’aide personnalisée sur les applets de commande en ligne dans la section d’aide du fournisseur des articles d’aide.

Pour plus d’informations sur les fournisseurs PowerShell, consultez about_Providers.

Remarque

Le fournisseur pour le chemin spécifié doit avoir un fichier d’aide du fournisseur PowerShell installé. Si aucun fichier d’aide du fournisseur n’est disponible, aucune information d’aide n’est retournée. Aucun fichier d’aide du fournisseur n’est disponible pour les fournisseurs inclus dans cette version de PowerShell.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Role

Affiche l'aide personnalisée du rôle d'utilisateur spécifié. Entrez un rôle. Les caractères génériques sont autorisés.

Entrez le rôle joué par l'utilisateur dans une organisation. Certaines applets de commande affichent du texte différent dans leurs fichiers d'aide en fonction de la valeur de ce paramètre. Ce paramètre n'a aucun effet sur l'aide des applets de commande de base.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ShowWindow

Affiche la rubrique d'aide dans une fenêtre pour faciliter la lecture. La fenêtre inclut une fonctionnalité de recherche de recherche et une zone de Paramètres qui vous permet de définir des options pour l’affichage, y compris les options permettant d’afficher uniquement les sections sélectionnées d’une rubrique d’aide.

Le paramètre ShowWindow prend en charge les rubriques d’aide pour les commandes (applets de commande, fonctions, commandes CIM, scripts) et les articles conceptuels About . Il ne prend pas en charge l’aide du fournisseur.

Ce paramètre a été réintroduite dans PowerShell 7.0. Ce paramètre est disponible uniquement sur Windows.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Entrées

None

Vous ne pouvez pas diriger les objets vers cette applet de commande.

Sorties

ExtendedCmdletHelpInfo

Si vous exécutez Get-Help sur une commande qui n’a pas de fichier d’aide, Get-Help retourne un objet ExtendedCmdletHelpInfo qui représente l’aide générée automatiquement.

String

Si vous obtenez un article d’aide conceptuelle, Get-Help retourne-le sous forme de chaîne.

MamlCommandHelpInfo

Si vous obtenez une commande qui a un fichier d’aide, Get-Help retourne un objet MamlCommandHelpInfo .

Notes

PowerShell 3.0 n’inclut pas de fichiers d’aide. Pour télécharger et installer les fichiers d’aide lus Get-Help , utilisez l’applet de Update-Help commande. Vous pouvez utiliser l’applet Update-Help de commande pour télécharger et installer des fichiers d’aide pour les commandes principales fournies avec PowerShell et pour tous les modules que vous installez. Vous pouvez également l'utiliser pour mettre à jour les fichiers d'aide afin que l'aide sur votre ordinateur ne soit jamais obsolète.

Vous pouvez également lire les articles d’aide sur les commandes fournies avec PowerShell en ligne à partir de La prise en main de Windows PowerShell.

Get-Help affiche de l’aide dans les paramètres régionaux définis pour le système d’exploitation Windows ou dans la langue de secours de ces paramètres régionaux. Si vous n’avez pas de fichiers d’aide pour les paramètres régionaux principaux ou de secours, Get-Help se comporte comme s’il n’existe aucun fichier d’aide sur l’ordinateur. Pour obtenir de l’aide sur des paramètres régionaux différents, utilisez région et langue dans Panneau de configuration pour modifier les paramètres. Sur Windows 10 ou version ultérieure, Paramètres, Time &Language.

La vue complète de l’aide inclut une table d’informations sur les paramètres. La table inclut les champs suivants :

  • Obligatoire. indique si le paramètre est obligatoire (true) ou facultatif (false).

  • Position. Indique si le paramètre est nommé ou positionnel (numérique). les paramètres positionnels doivent apparaître à un emplacement spécifié de la commande.

  • Nommé indique que le nom du paramètre est requis, mais que le paramètre peut apparaître n’importe où dans la commande.

  • Numérique indique que le nom du paramètre est facultatif, mais lorsque le nom est omis, le paramètre doit se trouver à la place spécifiée par le nombre. Par exemple, 2 indique que lorsque le nom du paramètre est omis, le paramètre doit être le deuxième ou seul paramètre non nommé dans la commande. Quand le nom du paramètre est utilisé, le paramètre peut apparaître n'importe où dans la commande.

  • Valeur par défaut. Valeur de paramètre ou comportement par défaut que PowerShell utilise si vous n’incluez pas le paramètre dans la commande.

  • Accepte l’entrée de pipeline. Indique si vous pouvez (true) ou ne pouvez pas (false) envoyer des objets au paramètre via un pipeline. Par nom de propriété signifie que l’objet pipeline doit avoir une propriété portant le même nom que le nom du paramètre.

  • Accepte les caractères génériques carte. Indique si la valeur d’un paramètre peut inclure des caractères génériques carte, tels qu’un astérisque (*) ou un point d’interrogation (?).