Show-Command

Referência

Módulo:: Microsoft.PowerShell.Utility

Exibe informações de comando do PowerShell em uma janela gráfica.

Syntax

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

Description

O Show-Command cmdlet permite criar um comando do PowerShell em uma janela de comando. Você pode usar os recursos da janela de comando para executar o comando ou fazê-la retornar o comando para você.

Show-Command é uma ferramenta de ensino e aprendizagem muito útil. Show-Command funciona em todos os tipos de comando, incluindo cmdlets, funções, fluxos de trabalho e comandos CIM.

Sem parâmetros, Show-Command exibe uma janela de comando que lista todos os comandos disponíveis em todos os módulos instalados. Para localizar os comandos em um módulo, selecione o módulo na lista suspensa Modules. Para selecionar um comando, clique no nome do comando.

Para usar a janela de comando, selecione um comando, usando o Nome ou clicando no nome do comando na lista Comandos . Cada conjunto de parâmetros é exibido em uma guia separada. Os asteriscos indicam os parâmetros obrigatórios. Para inserir valores para um parâmetro, digite o valor na caixa de texto ou selecione o valor da caixa suspensa. Para adicionar um parâmetro de opção, clique para selecionar a caixa de seleção do parâmetro.

Quando estiver pronto, você pode clicar em Copiar para copiar o comando que você criou para a área de transferência ou clicar em Executar para executar o comando. Você também pode usar o parâmetro PassThru para retornar o comando ao programa host, como o console do PowerShell. Para cancelar a seleção de comandos e retornar ao modo de exibição que exibe todos os comandos, pressione Ctrl e clique no comando selecionado.

No PowerShell Integrated Scripting Environment (ISE), uma variação da Show-Command janela é exibida por padrão. Para obter informações sobre como usar essa janela de comando, consulte os tópicos da Ajuda do ISE do PowerShell.

Esse cmdlet foi introduzido no PowerShell 3.0.

Como esse cmdlet requer uma interface de usuário, ele não funciona no Windows Server Core ou no Windows Nano Server. Esse cmdlet só está disponível em sistemas Windows que oferecem suporte à Área de Trabalho do Windows.

Exemplos

Exemplo 1: Abrir a janela Comandos

Este exemplo exibe o modo de exibição padrão da Show-Command janela. A janela Comandos exibe uma lista de todos os comandos em todos os módulos instalados no computador.

Show-Command

Exemplo 2: Abrir um cmdlet na janela Comandos

Este exemplo exibe o Invoke-Command cmdlet na janela Comando . Você pode usar essa exibição para executar Invoke-Command comandos.

Show-Command -Name "Invoke-Command"

Exemplo 3: Abrir um cmdlet com parâmetros especificados

Esse comando abre uma Show-Command janela para oConnect-PSSessioncmdlet.

Show-Command -Name "Connect-PSSession" -Height 700 -Width 1000 -ErrorPopup

Os parâmetros Height e Width especificam a dimensão da janela de comando. O parâmetro ErrorPopup exibe a janela de comando de erro.

Quando você clica em Executar, o Connect-PSSession comando é executado, assim como faria se você digitasse o Connect-PSSession comando na linha de comando.

Exemplo 4: Especificar novos valores de parâmetro padrão para um cmdlet

Este exemplo usa a $PSDefaultParameterValues variável automática para definir novos valores padrão para os parâmetros Height, Width e ErrorPopup do Show-Command cmdlet.

$PSDefaultParameterValues = @{
    "Show-Command:Height" = 700
    "Show-Command:Width" = 1000
    "Show-Command:ErrorPopup" = $True
}

Agora, quando você executa um Show-Command comando, os novos padrões são aplicados automaticamente. Para usar esses valores padrão em cada sessão do PowerShell, adicione a $PSDefaultParameterValues variável ao seu perfil do PowerShell. Para obter mais informações, consulte about_Profiles e about_Parameters_Default_Values.

Exemplo 5: Enviar saída para um modo de exibição de grade

Este comando mostra como usar os Show-Command cmdlets e Out-GridView juntos.

Show-Command Get-ChildItem | Out-GridView

O comando usa o Show-Command cmdlet para abrir uma janela de comando para oGet-ChildItemcmdlet. Quando você clica no botão Executar , o Get-ChildItem comando é executado e gera saída. O operador de pipeline ( | ) envia a Get-ChildItem saída do comando para o Out-GridView cmdlet, que exibe a Get-ChildItem saída em uma janela interativa.

Exemplo 6: Exibir um comando criado na janela Comandos

Este exemplo mostra o comando que você criou na Show-Command janela. O comando usa o parâmetro PassThru , que retorna os Show-Command resultados em uma cadeia de caracteres.

Show-Command -PassThru

Get-EventLog -LogName "Windows PowerShell" -Newest 5

Por exemplo, se você usar a Show-Command janela para criar um Get-EventLog comando que obtém os cinco eventos mais recentes no log de eventos do Windows PowerShell e, em seguida, clique em OK, o comando retornará a saída mostrada acima. Exibir a cadeia de caracteres de comando ajuda você a aprender o PowerShell.

Exemplo 7: Salvar um comando em uma variável

Este exemplo mostra como executar a cadeia de caracteres de comando que você obtém ao usar o parâmetro PassThru do Show-Command cmdlet. Essa estratégia permite ver o comando e usá-lo.

$C = Show-Command -PassThru
$C
Invoke-Expression $C

Get-EventLog -LogName "PowerShell" -Newest 5

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

O primeiro comando usa o parâmetro PassThru do Show-Command cmdlet e salva os resultados do comando na $C variável. Nesse caso, usamos a Show-Command janela para criar um Get-EventLog comando que obtém os cinco eventos mais recentes no log de eventos do Windows PowerShell. Quando você clica $C em OK,Show-Command retorna a sequência de comando, que é salva na variável.

Exemplo 8: Salvar a saída de um comando em uma variável

Este exemplo usa o parâmetro ErrorPopup para salvar a saída de um comando em uma variável.

$P = Show-Command Get-Process -ErrorPopup
$P

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----      ----- -----   ------     -- -----------
    473      33    94096     112532   709     2.06   4492 powershell

Além de exibir erros em uma janela, ErrorPopup retorna a saída do comando para o comando atual, em vez de criar um novo comando. Quando você executa esse comando, a Show-Command janela é aberta. Você pode usar os recursos de janela para definir valores de parâmetro. Para executar o comando, clique no botão Executar na Show-Command janela.

Parâmetros

-ErrorPopup

Indica que o cmdlet exibe erros em uma janela pop-up, além de exibi-los na linha de comando. Por padrão, quando um comando executado em uma Show-Command janela gera um erro, o erro é exibido somente na linha de comando.

Além disso, quando você executa o comando (usando o botão Executar na Show-Command janela), o parâmetro ErrorPopup retorna os resultados do comando para o comando atual, em vez de executar o comando e retornar sua saída para um novo comando. Você pode usar esse recurso para salvar os resultados do comando em uma variável.

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

-Height

Especifica a Show-Command altura da janela em pixels. Insira um valor entre 300 e o número de pixels na resolução de tela. Se o valor for muito grande para exibir a janela de comando na tela, Show-Command gerará um erro. A altura padrão é 600 pixels. Para um Show-Command comando que inclui o parâmetro Name , a altura padrão é 300 pixels.

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

-Name

Exibe uma janela de comando para o comando especificado. Insira o nome de um comando, como o nome de um cmdlet, função ou comando CIM. Se você omitir esse parâmetro, Show-Command exibirá uma janela de comando que lista todos os comandos do PowerShell em todos os módulos instalados no computador.

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

-NoCommonParameter

Indica que esse cmdlet omite a seção Parâmetros Comuns da exibição do comando. Por padrão, Parâmetros Comuns aparece em uma seção expansível na parte inferior da janela de comando.

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

-PassThru

Retorna um objeto que representa o item com que você está trabalhando. Por padrão, este cmdlet não gera saída. Para executar a cadeia de comando, copie-a e cole-a no prompt de comando ou salve-a em uma variável e use o Invoke-Expression cmdlet para executar a cadeia de caracteres na variável.

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

-Width

Especifica a Show-Command largura da janela em pixels. Insira um valor entre 300 e o número de pixels na resolução de tela. Se o valor for muito grande para exibir a janela de comando na tela, Show-Command gerará um erro. A largura padrão é 300 pixels.

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

Entradas

None

Não é possível canalizar objetos para esse cmdlet.

Saídas

None

Por padrão, esse cmdlet não retorna nenhuma saída.

String

Quando você usa o parâmetro PassThru , esse cmdlet retorna uma cadeia de caracteres de comando.

Object

Quando você usa o parâmetro ErrorPopup , esse cmdlet retorna a saída do comando (qualquer objeto).

Observações

O Windows PowerShell inclui os seguintes aliases para Show-Command:

shcm

Show-Command não funciona em sessões remotas.