Show-Command

Référence

Module:: Microsoft.PowerShell.Utility

Crée des commandes Windows PowerShell dans une fenêtre de commande graphique.

Syntax

Show-Command
    [[-Name] <String>]
    [-Height <Double>]
    [-Width <Double>]
    [-NoCommonParameter]
    [-ErrorPopup]
    [-PassThru]
    [<CommonParameters>]

Description

L'applet de commande Show-Command vous permet de créer une commande Windows PowerShell dans une fenêtre de commandes. Vous pouvez utiliser les fonctionnalités de la fenêtre de commandes pour qu'elle exécute la commande, ou pour qu'elle vous la retourne.

Show-Command est un outil d’enseignement et d’apprentissage très utile. Show-Command fonctionne sur tous les types de commande, y compris les applets de commande, les fonctions, les workflows et les commandes CIM.

Sans paramètres, Show-Command affiche une fenêtre de commandes qui répertorie toutes les commandes disponibles dans tous les modules installés. Pour trouver les commandes d'un module, sélectionnez le module dans la liste déroulante Modules. Pour sélectionner une commande, cliquez sur son nom.

Pour utiliser la fenêtre de commande, sélectionnez une commande, soit à l’aide du Nom, soit en cliquant sur le nom de la commande dans la liste Commandes . Chaque jeu de paramètres s’affiche sous un onglet distinct. Les astérisque indiquent les paramètres obligatoires. Pour entrer des valeurs pour un paramètre, tapez la valeur dans la zone de texte ou sélectionnez la valeur dans la zone de liste déroulante. Pour ajouter un paramètre de commutateur, cliquez et cochez la case du paramètre.

Quand vous êtes prêt, cliquez sur Copy pour copier la commande que vous avez créée dans le Presse-papiers, ou cliquez sur Run pour exécuter la commande. Vous pouvez également utiliser le paramètre PassThru pour renvoyer la commande au programme hôte, par exemple la console Windows PowerShell. Pour annuler la sélection de commande et revenir à la vue qui affiche toutes les commandes, appuyez sur Ctrl, puis cliquez sur la commande sélectionnée.

Dans l'Environnement d'écriture de scripts intégré de Windows PowerShell (ISE), une variante de la fenêtre Show-Command s'affiche par défaut. Pour plus d’informations sur l’utilisation de cette fenêtre de commande, consultez les rubriques d’aide Windows PowerShell ISE.

Cette applet de commande a été introduite dans Windows PowerShell 3.0.

Exemples

Exemple 1 : Ouvrir la fenêtre Commandes

PS C:\> Show-Command

Cette commande montre l'affichage par défaut de la fenêtre Show-Command. La fenêtre Commandes affiche une liste de toutes les commandes dans tous les modules installés sur l’ordinateur.

Exemple 2 : Ouvrir une applet de commande dans la fenêtre Commandes

PS C:\> Show-Command -Name "Invoke-Command"

Cette commande ouvre l’affichage de l’applet de commande Invoke-Command dans la fenêtre Afficher-Commande . Vous pouvez utiliser l’affichage Invoke-Command pour exécuter des commandes Invoke-Command .

Exemple 3 : Ouvrir une applet de commande avec les paramètres spécifiés

PS C:\> Show-Command -Name "Connect-PSSession" -Height 700 -Width 1000 -ErrorPopup

Cette commande ouvre une fenêtre Show-Command pour l’applet de commande Connect-PSSession. Elle utilise les paramètres Height et Width pour spécifier la dimension de la fenêtre de commandes, ainsi que le paramètre ErrorPopup pour afficher la fenêtre de commandes d'erreur.

Quand vous cliquez sur Run, la commande Connect-PSSession s'exécute, comme si vous aviez tapé la commande Connect-PSSession sur la ligne de commande.

Exemple 4 : Spécifier de nouvelles valeurs de paramètre par défaut pour une applet de commande

PS C:\> $PSDefaultParameterValues = @{"Show-Command:Height" = 700; "Show-Command:Width" = 1000; "Show-Command:ErrorPopup" = $True}

Cette commande utilise la variable automatique $PSDefaultParameterValues pour définir les nouvelles valeurs par défaut des paramètres Height, Width et ErrorPopup de l'applet de commande Show-Command. Désormais, quand vous exécutez une commande Show-Command, les nouvelles valeurs par défaut sont appliquées automatiquement.

Pour utiliser ces valeurs par défaut dans toutes les sessions Windows PowerShell, ajoutez la variable $PSDefaultParameterValues à votre profil Windows PowerShell. Pour plus d’informations, consultez about_Profiles et about_Parameters_Default_Values.

Exemple 5 : Envoyer une sortie à une vue grille

PS C:\> Show-Command Get-ChildItem | Out-GridView

Cette commande montre comment utiliser les applets de commande Show-Command et Out-GridView ensemble.

La commande utilise l’applet de commande Show-Command pour ouvrir une fenêtre de commande pour l’applet de commande Get-ChildItem. Quand vous cliquez sur le bouton Run, la commande Get-ChildItem s'exécute et génère une sortie. L'opérateur de pipeline (|) envoie la sortie de la commande Get-ChildItem à l'applet de commande Out-GridView, qui affiche la sortie de Get-ChildItem dans une fenêtre interactive.

Exemple 6 : Afficher une commande que vous créez dans la fenêtre Commandes

PS C:\> Show-Command -PassThru
Get-EventLog -LogName "Windows PowerShell" -Newest 5

Cette commande affiche la commande que vous avez créée dans la fenêtre Show-Command. La commande utilise le paramètre PassThru , qui retourne les résultats Show-Command dans une chaîne.

Par exemple, si vous utilisez la fenêtre Show-Command pour créer une commande Get-EventLog qui obtient les cinq événements les plus récents dans le journal des événements Windows PowerShell, puis cliquez sur OK, la commande retourne la sortie suivante.

L'affichage de la chaîne de commande vous aide à découvrir comment fonctionne Windows PowerShell.

Exemple 7 : Enregistrer une commande dans une variable

PS C:\> $C = Show-Command -PassThru

This command displays the command string in the $C variable.
PS C:\> $C
Get-EventLog -LogName "Windows PowerShell" -Newest 5

These commands use the Invoke-Expression cmdlet to run the string in the $C variable. The first command uses the full cmdlet name. The second command uses the "iex" alias for the **Invoke-Expression** cmdlet. These commands are equivalent and you can use them interchangeably.The output shows the five newest events in the Windows PowerShell event log.
PS C:\> Invoke-Expression $C

PS C:\> iex $C
   Index Time          EntryType   Source                 InstanceID Message
   ----- ----          ---------   ------                 ---------- -------
   11520 Dec 16 16:37  Information PowerShell                    400 Engine state is changed from None to Available....
   11519 Dec 16 16:37  Information PowerShell                    600 Provider "Variable" is Started. ...
   11518 Dec 16 16:37  Information PowerShell                    600 Provider "Registry" is Started. ...
   11517 Dec 16 16:37  Information PowerShell                    600 Provider "Function" is Started. ...
   11516 Dec 16 16:37  Information PowerShell                    600 Provider "FileSystem" is Started. ...

Cette commande montre comment exécuter la chaîne de commande que vous obtenez quand vous utilisez le paramètre PassThru de l'applet de commande Show-Command. Cette stratégie vous permet de voir la commande et de l'utiliser.

La première commande utilise le paramètre PassThru de l'applet de commande Show-Command. Il enregistre les résultats de la commande dans la variable $C.

La commande ouvre une fenêtre Show-Command . Dans ce cas, nous utilisons la fenêtre Show-Command pour créer une commande Get-EventLog qui obtient les cinq événements les plus récents dans le journal des événements Windows PowerShell. Lorsque vous cliquez sur OK, Show-Command retourne la chaîne de commande, qui est enregistrée dans la variable $C.

Exemple 8 : Enregistrer la sortie d’une commande dans une variable

PS C:\> $P = Show-Command Get-Process -ErrorPopup

The second command displays the value in the $P variable.
PS C:\> $P
Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id ProcessName

-------  ------    -----      ----- -----   ------     -- -----------

    473      33    94096     112532   709     2.06   4492 powershell

Ces commandes utilisent le paramètre ErrorPopup de l'applet de commande Show-Command pour enregistrer la sortie d'une commande dans une variable.

La première commande exécute l'applet de commande Show-Command avec le paramètre ErrorPopup. Outre l'affichage des erreurs dans une fenêtre, ErrorPopup retourne la sortie de commande dans la commande actuelle, au lieu de créer une commande.

Quand vous exécutez cette commande, la fenêtre Show-Command s'ouvre. Vous pouvez utiliser les fonctionnalités de la fenêtre pour définir les valeurs de paramètre. Pour exécuter la commande, cliquez sur le bouton Run situé dans la fenêtre Show-Command.

Paramètres

-ErrorPopup

Indique que l’applet de commande affiche les erreurs dans une fenêtre contextuelle, en plus de les afficher sur la ligne de commande. Par défaut, lorsqu’une commande exécutée dans une fenêtre Show-Command génère une erreur, l’erreur s’affiche uniquement sur la ligne de commande.

En outre, quand vous exécutez la commande (à l'aide du bouton Run situé dans la fenêtre Show-Command), le paramètre ErrorPopup retourne les résultats de la commande active, au lieu d'exécuter la commande et de retourner sa sortie dans une nouvelle commande. Vous pouvez utiliser cette fonctionnalité pour enregistrer les résultats de la commande dans une variable.

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

-Height

Spécifie la hauteur de la fenêtre Show-Command en pixels. Entrez une valeur comprise entre 300 et le nombre de pixels de la résolution d'écran. Si la valeur est trop importante pour afficher la fenêtre de commandes à l'écran Show-Command génère une erreur. La hauteur par défaut est de 600 pixels. Pour une commande Show-Command qui inclut le paramètre Name, la hauteur par défaut est de 300 pixels.

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

-Name

Affiche une fenêtre de commandes pour la commande spécifiée. Entrez le nom d'une commande, par exemple le nom d'une applet de commande, d'une fonction, d'un workflow ou d'une commande CIM. Si vous omettez ce paramètre, Show-Command affiche une fenêtre de commandes qui répertorie toutes les commandes Windows PowerShell de tous les modules installés sur l'ordinateur.

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

-NoCommonParameter

Indique que cette applet de commande omet la section Paramètres communs de l’affichage des commandes. Par défaut, les paramètres communs apparaissent dans une section extensible en bas de la fenêtre de commandes.

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

-PassThru

Retourne un objet représentant l’élément que vous utilisez. Par défaut, cette applet de commande ne génère aucun résultat.

Pour exécuter la chaîne de commande, copiez-la, puis collez-la à l'invite de commandes, ou enregistrez-la dans une variable et utilisez l'applet de commande Invoke-Expression pour exécuter la chaîne dans la variable.

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

-Width

Spécifie la largeur de la fenêtre Show-Command en pixels. Entrez une valeur comprise entre 300 et le nombre de pixels de la résolution d'écran. Si la valeur est trop importante pour afficher la fenêtre de commandes à l'écran Show-Command génère une erreur. La largeur par défaut est de 300 pixels.

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

Entrées

None

Vous ne pouvez pas diriger l’entrée vers Show-Command.

Sorties

System.String, System.Object

Quand vous utilisez le paramètre PassThru, Show-Command retourne une chaîne de commande. Quand vous utilisez le paramètre ErrorPopup, Show-Command retourne la sortie de commande (tout objet). Sinon, Show-Command ne génère aucune sortie.

Notes

Show-Command ne fonctionne pas dans les sessions à distance.

Partager via