Compartilhar via

Show-Command

Módulo:
Microsoft.PowerShell.Utility Module

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

Sintaxe

Default (Padrão) 

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 do . 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 comutador, clique para selecionar a caixa de seleção do parâmetro.

Quando estiver pronto, clique em Copiar para copiar o comando que você criou na á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 comando 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. Esse cmdlet só está disponível em sistemas Windows que dão suporte à Área de Trabalho do Windows.

Exemplos

Exemplo 1: Abrir a janela Comandos

Este exemplo exibe a 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 comando. 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

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

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

Os parâmetros de Altura e largura 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 faria 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 parâmetros 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 exibição de grade

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 a 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 o Show-Command resulta 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 obtém os cinco eventos mais recentes no log de eventos do Windows PowerShell e, em seguida, clicar 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 cmdlet Show-Command. Essa estratégia permite que você veja o comando e o use.

$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 OK, Show-Command retorna a cadeia de caracteres 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 de 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 de 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 apenas 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.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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 é de 300 pixels.

Propriedades do parâmetro

Tipo:Double
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:CommandName

Conjuntos de parâmetros

(All)
Cargo:0
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-NoCommonParameter

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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 caracteres de comando, copie 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.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Width

Especifica a largura 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 largura padrão é de 300 pixels.

Propriedades do parâmetro

Tipo:Double
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

None

Não é possível transferir 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 PowerShell inclui os seguintes aliases para Show-Command:

  • Windows:
    • shcm

Este cmdlet está disponível apenas em plataformas Windows.

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