Show-Command

Referência

Módulo:: Microsoft.PowerShell.Utility

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

Sintaxe

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

Description

Este cmdlet só está disponível na plataforma Windows.

O cmdlet Show-Command 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 fazer com que ele retorne 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 Módulos. 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 na caixa suspensa. Para adicionar um parâmetro de opção, clique para selecionar a caixa de seleção 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 à exibição que exibe todos os comandos, pressione Ctrl e clique no comando selecionado.

No ISE (Ambiente de Script Integrado) do PowerShell, uma variação da janela Show-Command é 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.

Este cmdlet foi reintroduzido no PowerShell 7.

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

Exemplos

Exemplo 1: Abrir a janela Comandos

Este exemplo exibe o modo de exibição padrão da janela Show-Command. 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 cmdlet Invoke-Command na janela Command. Você pode usar essa exibição para executar comandos Invoke-Command.

Show-Command -Name "Invoke-Command"

Exemplo 3: Abrir um cmdlet com parâmetros especificados

Este comando abre uma janela de Show-Command para o cmdletConnect-PSSession.

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 comando Connect-PSSession é executado, assim como se você digitasse o comando Connect-PSSession na linha de comando.

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

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

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

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

Exemplo 5: Enviar saída para uma vista de grelha

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

Show-Command Get-ChildItem | Out-GridView

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

Exemplo 6: Exibir um comando criado na janela Comandos

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

Show-Command -PassThru

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

Por exemplo, se você usar a janela Show-Command para criar um comando Get-EventLog que obtenha 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 quando usa o parâmetro PassThru do cmdlet Show-Command. Essa estratégia permite que você veja o comando e use-o.

$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 cmdlet Show-Command e salva os resultados do comando na variável $C. Nesse caso, usamos a janela Show-Command para criar um comando Get-EventLog que obtém os cinco eventos mais recentes no log de eventos do Windows PowerShell. Quando você clica em OK, Show-Command retorna a cadeia de comando, que é salva na variável $C.

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 janela Show-Command é aberta. Você pode usar os recursos da janela para definir valores de parâmetro. Para executar o comando, clique no botão Executar na janela Show-Command.

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 janela Show-Command 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 janela Show-Command), 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.

Tipo:	SwitchParameter
Position:	Named
Default value:	False
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Height

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

Tipo:	Double
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Name

Exibe uma janela de comando para o comando especificado. Digite 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.

Tipo:	String
Aliases:	CommandName
Position:	0
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-NoCommonParameter

Indica que esse cmdlet omite a seção Common Parameters da exibição de comandos. Por padrão, os parâmetros comuns aparecem em uma seção expansível na parte inferior da janela de comando.

Tipo:	SwitchParameter
Position:	Named
Default value:	False
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-PassThru

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

Tipo:	SwitchParameter
Position:	Named
Default value:	False
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Width

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

Tipo:	Double
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

Entradas

None

Não é possível canalizar objetos para este 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).

Notas

O PowerShell inclui os seguintes aliases para Show-Command:

Janelas:
- shcm

Este cmdlet só está disponível em plataformas Windows.

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

Partilhar via