Compartilhar via

Get-Help

  • Referência
Módulo:
Microsoft.PowerShell.Core

Exibe informações sobre os comandos e conceitos do PowerShell.

Sintaxe

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Full]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Detailed
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Examples
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Parameter <String[]>
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -Online
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -ShowWindow
   [<CommonParameters>]

Description

O cmdlet Get-Help exibe informações sobre os conceitos e comandos do PowerShell, incluindo cmdlets, funções, comandos CIM (Common Information Model), fluxos de trabalho, provedores, aliases e scripts.

Para obter ajuda para um cmdlet do PowerShell, digite Get-Help seguido pelo nome do cmdlet, como: Get-Help Get-Process.

Artigos de ajuda conceitual no PowerShell começam com about_, como about_Comparison_Operators. Para ver todos os artigos about_, digite Get-Help about_*. Para ver um artigo específico, digite Get-Help about_<article-name>, como Get-Help about_Comparison_Operators.

Para obter ajuda para um provedor do PowerShell, digite Get-Help seguido pelo nome do provedor. Por exemplo, para obter ajuda para o provedor de certificados, digite Get-Help Certificate.

Você também pode digitar help ou man, que exibe uma tela de texto por vez. Ou, <cmdlet-name> -?, que é idêntico a Get-Help, mas só funciona para cmdlets.

Get-Help obtém o conteúdo de ajuda que exibe direto dos arquivos de ajuda em seu computador. Sem os arquivos de ajuda, Get-Help exibe apenas informações básicas sobre cmdlets. Alguns módulos do PowerShell incluem arquivos de ajuda. A partir do PowerShell 3.0, os módulos que vêm com o sistema operacional Windows não incluem arquivos de ajuda. Para baixar ou atualizar os arquivos de ajuda de um módulo no PowerShell 3.0, use o cmdlet Update-Help.

Você também pode exibir os documentos de ajuda do PowerShell online. Para obter a versão online de um arquivo de ajuda, use o parâmetro Online, como: Get-Help Get-Process -Online.

Se você digitar Get-Help seguido pelo nome exato de um artigo de ajuda ou por uma palavra exclusiva para um artigo de ajuda, Get-Help exibirá o conteúdo do artigo. Se você especificar o nome exato de um alias de comando, Get-Help exibirá a ajuda para o comando original. Se você inserir uma palavra ou padrão de palavra que aparece em vários títulos de artigos de ajuda, Get-Help exibirá uma lista de títulos correspondentes. Se você inserir qualquer texto que não apareça em nenhum título de artigo de ajuda, Get-Help exibirá uma lista de artigos que incluem esse texto em seu conteúdo.

Get-Help pode acessar artigos de ajuda para todos os idiomas e localizações com suporte. Get-Help primeiro procura arquivos de ajuda na localidade definida para o Windows, depois na localidade pai, como pt para pt-BR e, por fim, em uma localidade de fallback. A partir do PowerShell 3.0, se Get-Help não encontrar ajuda na localidade de fallback, ele procurará artigos de ajuda em inglês, en-US, antes de retornar uma mensagem de erro ou exibir ajuda gerada automaticamente.

Para obter informações sobre os símbolos que Get-Help exibe no diagrama de sintaxe de comando, consulte about_Command_Syntax. Para obter informações sobre atributos de parâmetro, como Obrigatório e Posição, consulte about_Parameters.

Nota

No PowerShell 3.0 e no PowerShell 4.0, Get-Help não consegue encontrar artigos sobre sobre em módulos, a menos que o módulo seja importado para a sessão atual. Para obter os artigos Sobre em um módulo, importe o módulo usando o cmdlet Import-Module ou executando um cmdlet incluído no módulo.

Começando com PSReadLine v2.2.2, o módulo é fornecido com duas funções que fornecem acesso rápido para ajudar enquanto você digita um comando na linha de comando. A ajuda é exibida no terminal em um buffer de tela alternativo com paginação.

Quando você atinge a tecla F1, a função PSReadLineShowCommandHelp invoca Get-Help -Full para o nome do cmdlet mais próximo à esquerda do cursor. Quando o cursor é imediatamente à esquerda de um parâmetro, a função salta para a descrição desse parâmetro no tópico de ajuda completo. Quando você atinge Q para sair da exibição de ajuda, você é retornado para a linha de comando na mesma posição do cursor para que você possa continuar digitando o comando.

Quando você usa a combinação de chaves Alt+h, a função ShowParameterHelpexibe informações de ajuda para o parâmetro imediatamente à esquerda do cursor. O texto da ajuda é exibido abaixo da linha de comando. Isso permite que você veja a descrição do parâmetro e continue digitando seu comando.

Para obter mais informações, consulte Usar a ajuda dinâmica.

Exemplos

Exemplo 1: Exibir informações básicas de ajuda sobre um cmdlet

Estes exemplos exibem informações básicas de ajuda sobre o cmdlet Format-Table.

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> é a sintaxe mais simples e padrão do cmdlet Get-Help. Você pode omitir o parâmetro Name.

A sintaxe <cmdlet-name> -? funciona apenas para cmdlets.

Exemplo 2: exibir informações básicas uma página de cada vez

Esses exemplos exibem informações básicas de ajuda sobre o cmdlet Format-Table uma página de cada vez.

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help é uma função que executa Get-Help cmdlet internamente e exibe o resultado uma página de cada vez.

man é um alias para a função help.

Get-Help Format-Table envia o objeto pelo pipeline. Out-Host -Paging recebe a saída do pipeline e exibe uma página de cada vez. Para obter mais informações, consulte Out-Host.

Exemplo 3: exibir mais informações para um cmdlet

Esses exemplos exibem informações de ajuda mais detalhadas sobre o cmdlet Format-Table.

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

O parâmetro Detailed exibe a visão detalhada do artigo de ajuda, incluindo as descrições dos parâmetros e os exemplos.

O parâmetro Full exibe a exibição completa do artigo de ajuda que inclui descrições de parâmetro, exemplos, tipos de objeto de entrada e saída e anotações adicionais.

Os parâmetros Detalhado e Completo só são eficazes para comandos que têm arquivos de ajuda instalados no computador. Os parâmetros não são eficazes para os artigos da ajuda conceituais (about_).

Exemplo 4: exibir partes selecionadas de um cmdlet usando parâmetros

Esses exemplos exibem partes selecionadas da ajuda do cmdlet Format-Table.

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

O parâmetro Examples exibe as seções NAME e SYNOPSIS do arquivo de ajuda, e todos os exemplos. Você não pode especificar um número de exemplo porque o parâmetro Exemplos é um parâmetro de alternância.

O parâmetro Parameter exibe apenas as descrições dos parâmetros especificados. Se você especificar apenas o caractere curinga asterisco (*), ele exibirá as descrições de todos os parâmetros. Quando Parameter especifica um nome de parâmetro como GroupBy, informações sobre esse parâmetro são mostradas.

Esses parâmetros não são eficazes para os artigos de ajuda conceituais (about_).

Exemplo 5: exibir a versão online da ajuda

Este exemplo exibe a versão online do artigo de ajuda do cmdlet Format-Table no navegador da Web padrão.

Get-Help Format-Table -Online

Exemplo 6: exibir ajuda sobre o sistema de ajuda

O cmdlet Get-Help sem parâmetros exibe informações sobre o sistema de ajuda do PowerShell.

Get-Help

Exemplo 7: Exibir artigos de ajuda disponíveis

Este exemplo exibe uma lista de todos os artigos de ajuda disponíveis em seu computador.

Get-Help *

Exemplo 8: Exibir uma lista de artigos conceituais

Este exemplo exibe uma lista dos artigos conceituais incluídos na ajuda do PowerShell. Todos esses artigos começam com os caracteres about_. Para exibir um arquivo de ajuda específico, digite Get-Help \<about_article-name\>, por exemplo, Get-Help about_Signing.

Somente os artigos conceituais que têm arquivos de ajuda instalados em seu computador são exibidos. Para obter informações sobre como baixar e instalar arquivos de ajuda no PowerShell 3.0, consulte Update-Help.

Get-Help about_*

Exemplo 9: pesquisar uma palavra na ajuda do cmdlet

Esse exemplo mostra como pesquisar uma palavra em um artigo de ajuda de um cmdlet.

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Help usa o parâmetro Full para obter as informações de ajuda para Add-Member. O objeto MamlCommandHelpInfo é enviado pelo pipeline. Out-String usa o parâmetro Stream para converter o objeto em uma cadeia de caracteres. Select-String usa o parâmetro Pattern para pesquisar a cadeia de caracteres Clixml.

Exemplo 10: Exibir uma lista de artigos que incluem uma palavra

Esse exemplo exibe uma lista de artigos que incluem a palavra remoto.

Quando você insere uma palavra que não aparece em nenhum título de artigo, Get-Help exibe uma lista de artigos que incluem essa palavra.

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

Exemplo 11: Exibir ajuda específica do provedor

Este exemplo mostra duas maneiras de obter a ajuda específica do provedor para Get-Item. Esses comandos recebem a ajuda que explica como usar o cmdlet Get-Item no nó DataCollection do provedor do SQL Server do PowerShell.

O primeiro exemplo usa o parâmetro Get-HelpPath para especificar o caminho do provedor do SQL Server. Como o caminho do provedor é especificado, você pode executar o comando de qualquer local de caminho.

O segundo exemplo usa Set-Location para navegar até o caminho do provedor do SQL Server. Nesse local, o parâmetro Path não é necessário para que Get-Help obtenha a ajuda específica do provedor.

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.
    ...

Set-Location SQLSERVER:\DataCollection
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.
    ...

Exemplo 12: Exibir ajuda para um script

Esse exemplo obtém-se ajuda para MyScript.ps1 script. Para obter informações sobre como escrever a ajuda para funções e scripts, consulte about_Comment_Based_Help.

Get-Help -Name C:\PS-Test\MyScript.ps1

Parâmetros

-Category

Exibe ajuda apenas para itens na categoria especificada e seus aliases. Os artigos conceituais estão na categoria HelpFile.

Os valores aceitáveis para esse parâmetro são os seguintes:

  • Alias
  • Cmdlet
  • Provedor
  • Geral
  • Perguntas Freqüentes
  • Glossário
  • Arquivo de Ajuda
  • ScriptCommand
  • Função
  • Filtro
  • ExternalScript
  • Todos
  • DefaultHelp
  • Fluxo de trabalho
  • DscResource
  • Classe
  • Configuração
Tipo:String[]
Valores aceitos:Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Component

Exibe comandos com o valor do componente especificado, como Exchange. Insira um nome de componente. Caracteres curinga são permitidos. Esse parâmetro não tem nenhum efeito em exibições da ajuda conceitual (About_).

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:True

-Detailed

Adiciona descrições de parâmetro e exemplos à exibição básica da ajuda. Esse parâmetro só é eficaz quando os arquivos de ajuda são instalados no computador. Ele não tem nenhum efeito em exibições da ajuda conceitual (About_).

Tipo:SwitchParameter
Cargo:Named
Valor padrão:False
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Examples

Exibe apenas o nome, a sinopse e os exemplos. Esse parâmetro só é eficaz quando os arquivos de ajuda são instalados no computador. Ele não tem nenhum efeito em exibições da ajuda conceitual (About_).

Tipo:SwitchParameter
Cargo:Named
Valor padrão:False
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Full

Exibe o artigo completo de ajuda para um cmdlet. completo inclui descrições de parâmetros e atributos, exemplos, tipos de objeto de entrada e saída e notas adicionais.

Esse parâmetro só é eficaz quando os arquivos de ajuda são instalados no computador. Ele não tem nenhum efeito em exibições da ajuda conceitual (About_).

Tipo:SwitchParameter
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Functionality

Exibe ajuda para itens com a funcionalidade especificada. Insira a funcionalidade. Caracteres curinga são permitidos. Esse parâmetro não tem nenhum efeito em exibições da ajuda conceitual (About_).

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:True

-Name

Obtém ajuda sobre o comando ou conceito especificado. Insira o nome de um cmdlet, função, provedor, script ou fluxo de trabalho, como Get-Member, um nome de artigo conceitual, como about_Objectsou um alias, como ls. Os caracteres curinga são permitidos em nomes de cmdlet e provedor, mas não é possível usar caracteres curinga para encontrar os nomes da ajuda das funções e dos artigos de ajuda dos scripts.

Para obter ajuda para um script que não está localizado em um caminho listado na variável de ambiente $env:Path, digite o caminho e o nome do arquivo do script.

Se você inserir o nome exato de um artigo de ajuda, Get-Help exibirá o conteúdo do artigo.

Se você inserir uma palavra ou padrão de palavra que aparece em vários títulos de artigos de ajuda, Get-Help exibirá uma lista de títulos correspondentes.

Se você inserir qualquer texto que não corresponda a nenhum título de artigo de ajuda, Get-Help exibirá uma lista de artigos que incluem esse texto em seu conteúdo.

Os nomes de artigos conceituais, como about_Objects, devem ser inseridos em inglês, mesmo em versões não em inglês do PowerShell.

Tipo:String
Cargo:0
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:True

-Online

Exibe a versão online de um artigo de ajuda no navegador padrão. Esse parâmetro é válido apenas para artigos de ajuda sobre cmdlets, funções, fluxos de trabalho e scripts. Você não pode usar o parâmetro Online com Get-Help em uma sessão remota.

Para obter informações sobre como dar suporte a esse recurso em artigos de ajuda que você escreve, consulte about_Comment_Based_Help e Suporte a Ajuda Online e Escrevendo a Ajuda para cmdlets do PowerShell.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:False
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Parameter

Exibe apenas as descrições detalhadas dos parâmetros especificados. Caracteres curinga são permitidos. Esse parâmetro não tem nenhum efeito em exibições da ajuda conceitual (About_).

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:True

-Path

Obtém ajuda que explica como o cmdlet funciona no caminho do provedor especificado. Insira um caminho de provedor do PowerShell.

Esse parâmetro obtém uma versão personalizada de um artigo de ajuda do cmdlet que explica como o cmdlet funciona no caminho especificado do provedor do PowerShell. Esse parâmetro é eficaz apenas para obter ajuda sobre um cmdlet de provedor e somente quando o provedor inclui uma versão personalizada do artigo de ajuda do cmdlet do provedor em seu arquivo de ajuda. Para usar esse parâmetro, instale o arquivo de ajuda para o módulo que inclui o provedor.

Para ver a ajuda do cmdlet personalizado para um caminho de provedor, acesse o local do caminho do provedor e insira um comando Get-Help ou, de qualquer local, use o parâmetro Path de Get-Help para especificar o caminho do provedor. Você também pode encontrar a ajuda online personalizada sobre o cmdlet na seção dos artigos de ajuda.

Para obter mais informações sobre provedores do PowerShell, consulte about_Providers.

Nota

O provedor do caminho especificado deve ter um arquivo de ajuda do provedor do PowerShell instalado. Se nenhum arquivo de ajuda do provedor estiver disponível, nenhuma informação de ajuda será retornada. Não há arquivos de ajuda do provedor disponíveis para os provedores incluídos nesta versão do PowerShell.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:True

-Role

Exibe a ajuda personalizada para a função de usuário especificada. Insira uma função. Caracteres curinga são permitidos.

Insira a função que o usuário desempenha em uma organização. Alguns cmdlets exibem texto diferente em seus arquivos de ajuda com base no valor desse parâmetro. Este parâmetro não tem nenhum efeito na ajuda para os cmdlets principais.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:True

-ShowWindow

Exibe o tópico de ajuda em uma janela para facilitar a leitura. A janela inclui um recurso de pesquisa Localizar e uma caixa de Configurações que permite definir opções para a exibição, incluindo opções para exibir apenas seções selecionadas em um tópico de ajuda.

O parâmetro ShowWindow dá suporte aos tópicos de ajuda para comandos (cmdlets, funções, comandos CIM, scripts) e artigos conceituais About. Ele não fornece ajuda sobre o provedor.

Esse parâmetro foi reintroduzido no PowerShell 7.0. Esse parâmetro só está disponível no Windows.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:False
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

None

Você não pode redirecionar objetos para este cmdlet.

Saídas

ExtendedCmdletHelpInfo

Se você executar Get-Help em um comando que não tenha um arquivo de ajuda, Get-Help retornará um objeto ExtendedCmdletHelpInfo que representa a ajuda gerada automaticamente.

String

Se você receber um artigo de ajuda conceitual, Get-Help o retornará como uma cadeia de caracteres.

MamlCommandHelpInfo

Se você obtiver um comando que tenha um arquivo de ajuda, Get-Help retornará um objeto MamlCommandHelpInfo.

Observações

O PowerShell 3.0 não inclui arquivos de ajuda. Para baixar e instalar os arquivos de ajuda que Get-Help lê, use o cmdlet Update-Help. Você pode usar o cmdlet Update-Help para baixar e instalar arquivos de ajuda para os comandos principais que vêm com o PowerShell e para todos os módulos instalados. Você também pode usá-lo para atualizar os arquivos de ajuda para que a ajuda em seu computador nunca esteja desatualizada.

Você também pode ler os artigos de ajuda sobre os comandos que vêm com o PowerShell online a partir de Introdução ao Windows PowerShell.

Get-Help exibe ajuda na configuração regional definida para o sistema operacional Windows ou no idioma alternativo para essa configuração. Se você não tiver arquivos de ajuda para a localidade primária ou de fallback, Get-Help se comportará como se não houvesse arquivos de ajuda no computador. Para obter ajuda para uma localidade diferente, use Region e Language no Painel de Controle para alterar as configurações. No Windows 10 ou posterior, Configurações, Hora e Idioma.

A exibição completa da ajuda inclui uma tabela de informações sobre os parâmetros. A tabela inclui os seguintes campos:

  • Obrigatório. Indica se o parâmetro é necessário (true) ou opcional (false).

  • Cargo. Indica se o parâmetro é nomeado ou posicional (numérico). Os parâmetros posicionais devem aparecer em um local especificado no comando.

  • Denominado indica que o nome do parâmetro é necessário, mas que o parâmetro pode aparecer em qualquer parte do comando.

  • O elemento numérico indica que o nome do parâmetro é opcional, mas quando o nome é omitido, o parâmetro deve estar na posição especificada pelo número. Por exemplo, 2 indica que, quando o nome do parâmetro é omitido, o parâmetro deve ser o segundo ou único parâmetro sem nome no comando. Quando o nome do parâmetro é usado, o parâmetro pode aparecer em qualquer lugar no comando.

  • valor padrão. O valor do parâmetro ou o comportamento padrão que o PowerShell usa se você não incluir o parâmetro no comando.

  • Aceita entrada de pipeline. Indica se você pode (true) ou não pode (false) enviar objetos para o parâmetro por meio de um pipeline. Por nome de propriedade significa que o objeto de pipeline deve ter uma propriedade que tenha o mesmo nome que o nome do parâmetro.

  • Aceita caracteres curinga. Indica se o valor de um parâmetro pode incluir caracteres curinga, como um asterisco (*) ou um ponto de interrogação (?).