NOM
Get-Help
RÉSUMÉ
Affiche des informations sur les commandes et les concepts Windows PowerShell.
SYNTAXE
Get-Help [-Full] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Get-Help [-Detailed] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Get-Help [-Examples] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Get-Help [-Parameter <string>] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
DESCRIPTION
L'applet de commande Get-Help affiche des informations sur les concepts et les commandes Windows PowerShell, notamment les applets de commande, les fournisseurs, les fonctions et les scripts. Pour obtenir la liste de tous les titres de rubriques d'aide relatives aux applets de commande, tapez « get-help * ».
Si vous tapez « Get-Help » suivi du nom exact d'une rubrique d'aide ou d'un mot spécifique à une rubrique d'aide, Get-Help affiche le contenu de la rubrique. Si vous entrez un mot ou modèle de mot qui apparaît dans plusieurs titres de rubrique d'aide, Get-Help affiche une liste des titres correspondants. Si vous entrez un mot qui n'apparaît dans aucun titre de rubrique d'aide, Get-Help affiche une liste des rubriques qui incluent ce mot dans leur contenu.
En plus de « get-help », vous pouvez également taper « help » ou « man », qui affiche un écran de texte à la fois, ou « <nom-applet-commande> -? », qui est identique à Get-Help, mais fonctionne uniquement pour les applets de commande.
Vous pouvez afficher le fichier d'aide entier ou certaines parties du fichier, comme la syntaxe, les paramètres ou des exemples. Vous avez également la possibilité d'utiliser le paramètre Online pour afficher une version en ligne d'un fichier d'aide dans votre navigateur Internet. Ces paramètres n'ont aucun effet sur les rubriques d'aide conceptuelles.
Les rubriques d'aide conceptuelles de Windows PowerShell commencent par le mot « about_ », comme dans « about_Comparison_Operators ». Pour consulter toutes les rubriques « about_ », tapez « get-help about_* ». Pour consulter une rubrique particulière, tapez « get-help about_<nom-rubrique> » (par exemple, « get-help about_Comparison_Operators » ).
PARAMÈTRES
-Category <string[]>
Affiche de l'aide sur les éléments se trouvant dans la catégorie spécifiée. Les valeurs valides sont Alias, Cmdlet, Provider et HelpFile. Les rubriques conceptuelles se trouvent dans la catégorie HelpFile.
Category est une propriété de l'objet MamlCommandHelpInfo retourné par Get-Help. Ce paramètre n'a aucun effet sur les affichages d'aide conceptuelle (« about_ »).
Obligatoire ? false
Position ? named
Valeur par défaut
Accepter l'entrée de pipeline ? false
Accepter les caractères génériques ? false
-Component <string[]>
Affiche une liste d'outils ayant la valeur de composant spécifiée (par exemple « Exchange »). Entrez un nom de composant. Les caractères génériques sont autorisés.
Component est une propriété de l'objet MamlCommandHelpInfo retourné par Get-Help. Ce paramètre n'a aucun effet sur les affichages d'aide conceptuelle (« About_ »).
Obligatoire ? false
Position ? named
Valeur par défaut
Accepter l'entrée de pipeline ? false
Accepter les caractères génériques ? false
-Detailed [<SwitchParameter>]
Ajoute à l'affichage d'aide de base des descriptions de paramètre et des exemples.
Ce paramètre n'a aucun effet sur les affichages d'aide conceptuelle (« About_ »).
Obligatoire ? false
Position ? named
Valeur par défaut
Accepter l'entrée de pipeline ? false
Accepter les caractères génériques ? false
-Examples [<SwitchParameter>]
Affiche uniquement le nom, le résumé et les exemples. Pour afficher uniquement les exemples, tapez « (get-help <nom-applet-commande>).examples ».
Ce paramètre n'a aucun effet sur les affichages d'aide conceptuelle (« About_ »).
Obligatoire ? false
Position ? named
Valeur par défaut
Accepter l'entrée de pipeline ? false
Accepter les caractères génériques ? false
-Full [<SwitchParameter>]
Affiche le fichier d'aide entier d'une applet de commande, notamment les descriptions de paramètre et attributs, exemples, types d'objet d'entrée et de sortie et remarques supplémentaires.
Ce paramètre n'a aucun effet sur les affichages d'aide conceptuelle (« About_ »).
Obligatoire ? false
Position ? named
Valeur par défaut
Accepter l'entrée de pipeline ? false
Accepter les caractères génériques ? false
-Functionality <string[]>
Affiche de l'aide sur les éléments ayant les fonctionnalités spécifiées. Entrez les fonctionnalités. Les caractères génériques sont autorisés.
Functionality est une propriété de l'objet MamlCommandHelpInfo retourné par Get-Help. Ce paramètre n'a aucun effet sur les affichages d'aide conceptuelle (« About_ »).
Obligatoire ? false
Position ? named
Valeur par défaut
Accepter l'entrée de pipeline ? false
Accepter les caractères génériques ? false
-Name <string>
Demande de l'aide sur la rubrique conceptuelle ou l'outil spécifié. Entrez le nom d'une applet de commande, d'un fournisseur, d'un script ou d'une fonction (par exemple, Get-Member), un nom de rubrique conceptuelle (par exemple, « about_Objects ») ou un alias (par exemple, « ls »). Les caractères génériques sont autorisés dans les noms d'applets de commande et de fournisseurs, mais vous ne pouvez pas utiliser de caractères génériques pour rechercher les noms de rubriques d'aide relatives à des fonctions et à des scripts.
Pour obtenir de l'aide sur un script qui ne figure dans un chemin d'accès répertorié dans la variable d'environnement Path, tapez le chemin d'accès et le nom de fichier du script.
Si vous entrez le nom exact d'une rubrique d'aide, Get-Help affiche le contenu de la rubrique. Si vous entrez un mot ou modèle de mot qui apparaît dans plusieurs titres de rubrique d'aide, Get-Help affiche une liste des titres correspondants. Si vous entrez un mot qui ne correspond à aucun titre de rubrique d'aide, Get-Help affiche une liste des rubriques qui incluent ce mot dans leur contenu.
Les noms de rubriques conceptuelles, tels qu'about_Objects, doivent être entrés en anglais, même dans les versions non anglaises de Windows PowerShell.
Obligatoire ? false
Position ? 1
Valeur par défaut
Accepter l'entrée de pipeline ? true (ByPropertyName)
Accepter les caractères génériques ? false
-Online [<SwitchParameter>]
Affiche la version en ligne d'une rubrique d'aide dans le navigateur Internet par défaut. Ce paramètre est valide uniquement pour les rubriques d'aide relatives à des applets de commande, des fonctions et des scripts.
Get-Help utilise l'adresse Internet (URI [Uniform Resource Identifier]) qui s'affiche dans le premier élément de la section Liens connexes d'une rubrique d'aide relative à une applet de commande, une fonction ou un script.
Ce paramètre fonctionne uniquement lorsque la rubrique d'aide inclut un URI commençant par « Http » ou « Https », et qu'un navigateur Internet est installé sur le système.
Pour plus d'informations sur la prise en charge de cette fonctionnalité dans les rubriques d'aide que vous écrivez, consultez about_Comment_Based_Help, ainsi que « Comment écrire l'aide d'une applet de commande » (page éventuellement en anglais) dans la bibliothèque MSDN (Microsoft Developer Network) à l'adresse http://go.microsoft.com/fwlink/?LinkID=123415.
Obligatoire ? false
Position ? named
Valeur par défaut Aucun
Accepter l'entrée de pipeline ? false
Accepter les caractères génériques ? false
-Parameter <string>
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_ »).
Obligatoire ? false
Position ? named
Valeur par défaut
Accepter l'entrée de pipeline ? false
Accepter les caractères génériques ? false
-Path <string>
Obtient une aide qui explique le fonctionnement de l'applet de commande dans le chemin d'accès du fournisseur spécifié. Entrez le chemin d'accès d'un fournisseur Windows PowerShell.
Ce paramètre obtient une version personnalisée d'une rubrique d'aide de l'applet de commande qui explique le fonctionnement de l'applet de commande dans le chemin d'accès du fournisseur Windows PowerShell spécifié. Ce paramètre n'a d'effet que pour l'aide relative à une applet de commande du fournisseur et uniquement lorsque le fournisseur inclut une version personnalisée de la rubrique d'aide correspondante.
Pour afficher l'aide d'applet de commande personnalisée pour un chemin d'accès de fournisseur, accédez à l'emplacement du chemin d'accès du fournisseur et entrez une commande Get-Help ou, à partir de n'importe quel emplacement de chemin d'accès, utilisez le paramètre Path de Get-Help pour spécifier le chemin d'accès du fournisseur. Pour plus d'informations, consultez about_Providers.
Obligatoire ? false
Position ? named
Valeur par défaut
Accepter l'entrée de pipeline ? false
Accepter les caractères génériques ? false
-Role <string[]>
Affiche de l'aide personnalisée sur le rôle de l'utilisateur spécifié. Entrez un rôle. Les caractères génériques sont autorisés.
Entrez le rôle que l'utilisateur joue dans une organisation. Certaines applets de commande affichent un 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 relative aux applets de commande principales.
Obligatoire ? false
Position ? named
Valeur par défaut
Accepter l'entrée de pipeline ? false
Accepter les caractères génériques ? false
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer et OutVariable. Pour plus d'informations, tapez
« get-help about_commonparameters ».
ENTRÉES
Aucun
Vous ne pouvez pas rediriger des objets vers cette applet de commande.
SORTIES
System.String ou MamlCommandHelpInfo
Si vous demandez une rubrique conceptuelle, Get-Help la retourne sous forme de chaîne. Si vous spécifiez le nom d'un applet de commande, d'une fonction ou d'un script, elle retourne un objet MamlCommandHelpInfo. Sinon, Get-Help retourne l'une des vues mises en forme qui sont spécifiées dans le fichier Help.Format.ps1xml du répertoire $pshome.
NOTES
Sans paramètres, « Get-Help » affiche des informations sur le système d'aide Windows PowerShell.
La vue complète de l'aide (-full) comprend un tableau d'informations sur les paramètres. Ce tableau inclut les champs suivants :
-- Obligatoire : indique si le paramètre est requis (true) ou facultatif (false).
-- Position : indique si le paramètre est nommé ou positionnel (numérique). Les paramètres positionnels doivent apparaître à une place spécifiée dans la commande.
-- "nommé" ("named") indique que le nom de paramètre est requis, mais que le paramètre peut apparaître n'importe où dans la commande.
-- <Nombre> indique que le nom de paramètre est facultatif, mais lorsque le nom est omis, le paramètre doit être à la place spécifiée par le nombre. Par exemple, « 2 » indique que lorsque le nom de paramètre est omis, le paramètre doit être le deuxième (2) ou le seul paramètre sans nom de la commande. Lorsque le nom de paramètre est utilisé, le paramètre peut apparaître n'importe où dans la commande.
-- Valeur par défaut : valeur de paramètre que Windows PowerShell utilise si vous n'incluez pas le paramètre dans la commande.
-- Accepter l'entrée de pipeline : indique si vous pouvez (true) ou non (false) envoyer des objets au paramètre à travers un pipeline. « Par nom de propriété » signifie que l'objet dirigé doit avoir une propriété portant le même nom que le nom de paramètre.
-- Accepter les caractères génériques : indique si la valeur d'un paramètre peut inclure des caractères génériques, tels que * et ?.
-------------------------- EXEMPLE 1 --------------------------
C:\PS>get-help
Description
-----------
Cette commande affiche de l'aide sur le système d'aide Windows PowerShell.
-------------------------- EXEMPLE 2 --------------------------
C:\PS>get-help *
Description
-----------
Cette commande affiche la liste de tous les fichiers d'aide du système d'aide Windows PowerShell.
-------------------------- EXEMPLE 3 --------------------------
C:\PS>get-help get-alias
C:\PS>help get-alias
C:\PS>get-alias -?
Description
-----------
Ces commandes affichent des informations de base sur l'applet de commande get-alias. Les commandes « Get-Help » et « -? » affichent les informations sur une seule page. La commande « Help » affiche les informations une page à la fois.
-------------------------- EXEMPLE 4 --------------------------
C:\PS>get-help about_*
Description
-----------
Cette commande affiche la liste des rubriques conceptuelles incluses dans l'aide de Windows PowerShell. Toutes ces rubriques commencent par les caractères « about_ ». Pour afficher un fichier d'aide particulier, tapez « get-help <nom-rubrique> » (par exemple, « get-help about_signing ».
-------------------------- EXEMPLE 5 --------------------------
C:\PS>get-help ls -detailed
Description
-----------
Cette commande affiche une aide détaillée sur l'applet de commande Get-ChildItem en spécifiant l'un de ses alias, « ls ». Le paramètre Detailed demande la vue détaillée du fichier d'aide, qui inclut des descriptions de paramètre et des exemples. Pour afficher la totalité du fichier d'aide sur une applet de commande, utilisez le paramètre Full.
-------------------------- EXEMPLE 6 --------------------------
C:\PS>get-help format-string -full
Description
-----------
Cette commande affiche la vue complète de l'aide sur l'applet de commande Format-String. La vue complète de l'aide inclut des descriptions de paramètres, des exemples et un tableau de détails techniques relatifs aux paramètres.
-------------------------- EXEMPLE 7 --------------------------
C:\PS>get-help start-service -examples
Description
-----------
Cette commande affiche des exemples illustrant l'utilisation de start-service dans les commandes Windows PowerShell
.
-------------------------- EXEMPLE 8 --------------------------
C:\PS>get-help get-childitem -parameter f*
Description
-----------
Cette commande affiche des descriptions des paramètres de l'applet de commande Get-ChildItem qui commencent par « f ») (filter et force). Pour obtenir des descriptions de tous les paramètres, tapez « get-help get-childitem parameter* ».
-------------------------- EXEMPLE 9 --------------------------
C:\PS>(get-help write-output).syntax
Description
-----------
Cette commande affiche uniquement la syntaxe de l'applet de commande Write-Output.
La syntaxe est l'une des nombreuses propriétés des objets de l'aide ; la description, les détails, les exemples et les paramètres en sont d'autres. Pour rechercher toutes les propriétés et méthodes des objets de l'aide, tapez « get-help <nom-applet-commande> | get-member » (par exemple, « get-help start-service | get member ».
-------------------------- EXEMPLE 10 --------------------------
C:\PS>(get-help trace-command).alertset
Description
-----------
Cette commande affiche les remarques sur l'applet de commande. Les remarques sont stockées dans la propriété alertSet de l'objet aide.
Elles incluent des informations conceptuelles et des conseils pour l'utilisation de l'applet de commande. Par défaut, les remarques sont affichées uniquement lorsque vous utilisez le paramètre Full de Get-Help, mais vous pouvez également les afficher à l'aide de la propriété alertSet.
-------------------------- EXEMPLE 11 --------------------------
C:\PS>get-help add-member -full | out-string -stream | select-string -pattern clixml
Description
-----------
Cet exemple montre comment rechercher un mot dans une rubrique d'aide d'applet de commande particulière. Cette comm ande recherche le mot « clixml » dans la version complète de la rubrique d'aide de l'applet de commande Add-Member.
Étant donné que l'applet de commande Get-Help génère un objet MamlCommandHelpInfo, et non une chaîne, vous devez utiliser une commande qui transforme le contenu de la rubrique d'aide en une chaîne, comme Out-String ou Out-File.
-------------------------- EXEMPLE 12 --------------------------
C:\PS>get-help get-member -online
Description
-----------
Cette commande affiche la version en ligne de la rubrique d'aide pour l'applet de commande Get-Member.
-------------------------- EXEMPLE 13 --------------------------
C:\PS>get-help remoting
Description
-----------
Cette commande affiche une liste de rubriques dont le contenu inclut le mot « remoting ».
Lorsque vous entrez un mot qui n'apparaît dans aucun titre de rubrique, Get-Help affiche une liste des rubriques qu
i incluent ce mot.
-------------------------- EXEMPLE 14 --------------------------
C:\PS>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.
...
C:\PS> cd SQLSERVER:\DataCollection
C:\PS> 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.
...
C:\PS> Get-Item
NAME
Get-Item
SYNOPSIS
Gets the item at the specified location.
...
Description
-----------
Cet exemple montre comment obtenir de l'aide pour l'applet de commande Get-Item qui explique comment utiliser l'applet de commande dans le noud DataCollection du fournisseur Windows PowerShell SQL Server.
L'exemple montre deux façons d'obtenir l'aide personnalisée pour Get-Item.
La première commande utilise le paramètre Path de Get-Help pour spécifier le chemin d'accès du fournisseur. Cette commande peut être entrée à n'importe quel emplacement du chemin d'accès.
La deuxième commande utilise l'applet de commande Set-Location (alias = « cd ») pour accéder au chemin d'accès du fournisseur. Même sans le paramètre Path, la commande Get-Help obtient l'aide personnalisée sur le chemin d'accès du fournisseur à partir de cet emplacement.
La troisième commande montre qu'une commande Get-Help dans un chemin d'accès de système de fichiers, et sans le paramètre Path, obtient l'aide standard sur l'applet de commande Get-Item.
-------------------------- EXEMPLE 15 --------------------------
C:\PS>get-help c:\ps-test\MyScript.ps1
Description
-----------
Cette commande obtient de l'aide pour le script MyScript.ps1. Pour plus d'informations sur l'écriture de l'aide relative à vos fonctions et scripts, consultez about_Comment_Based_Help.
LIENS CONNEXES
Online version: http://go.microsoft.com/fwlink/?LinkID=113316
about_Comment_Based_Help
Get-Command
Get-PSDrive
Get-Member
Aucun commentaire:
Enregistrer un commentaire