Get-Help
Exibe informações sobre comandos e conceitos do Windows PowerShell.
Sintaxe
Get-Help [-Full] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Get-Help [-Detailed] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Get-Help [-Exemplos] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Get-Help [-Parameter <string>] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Descrição
O cmdlet Get-Help exibe informações sobre conceitos e comandos do Windows PowerShell, incluindo cmdlets, provedores, funções e scripts. Para obter uma lista de todos os títulos de tópicos de ajuda do cmdlet, digite "get-help *".
Se você digitar "Get-Help" seguido pelo nome exato de um tópico da Ajuda ou de uma palavra exclusiva de um tópico da Ajuda, Get-Help exibirá o conteúdo do tópico. Se você digitar uma palavra ou um padrão de palavras que aparece em vários títulos de tópico de ajuda, Get-Help exibirá uma lista de títulos correspondentes. Se você digitar uma palavra que não aparece em nenhum título de tópico de ajuda, Get-Help exibirá uma lista de tópicos que inclui essa palavra em seu conteúdo.
Além de "get-help", você também pode digitar "help" ou "man", que exibe uma tela de texto de cada vez, ou "<nome-do-cmdlet> -?", que é idêntico a Get-Help, mas funciona apenas para cmdlets.
Você pode exibir o arquivo de ajuda inteiro ou partes selecionadas do arquivo, como a sintaxe, os parâmetros ou exemplos. Você também pode usar o parâmetro Online para exibir uma versão online de um arquivo de ajuda no navegador de Internet. Esses parâmetros não têm efeito sobre tópicos conceituais da Ajuda.
Os tópicos conceituais da Ajuda no Windows PowerShell começam com "about_", como "about_Comparison_Operators". Para consultar todos os tópicos "about_", digite "get-help about_*". Para consultar um tópico específico, digite "get-help about_ <nome-do-tópico>", como "get-help about_Comparison Operators".
Parâmetros
-Category <string[]>
Exibe ajuda para itens na categoria especificada. Os valores válidos são Alias, Cmdlet, Provider e HelpFile. Tópicos conceituais estão na categoria HelpFile.
Category é uma propriedade do objeto MamlCommandHelpInfo retornada por Get-Help. Esse parâmetro não tem efeito sobre exibições de ajuda conceitual ("about_").
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Component <string[]>
Exibe uma lista de ferramentas com o valor do componente especificado, como "Exchange". Digite um nome de componente. Os caracteres curinga são permitidos.
Component é uma propriedade do objeto MamlCommandHelpInfo retornada por Get-Help. Esse parâmetro não tem efeito sobre exibições de ajuda conceitual ("About_").
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Detailed
Adiciona descrições de parâmetro e exemplos à exibição básica de ajuda.
Esse parâmetro não tem efeito sobre exibições de ajuda conceitual ("About_").
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Exemplos
Exibe apenas o nome, a sinopse e os exemplos. Para exibir apenas os exemplos, digite "(get-help <nome-do-cmdlet>).examples".
Esse parâmetro não tem efeito sobre exibições de ajuda conceitual ("About_").
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Full
Exibe o arquivo de ajuda inteiro para um cmdlet, inclusive descrições e atributos de parâmetros, exemplos, tipos de objeto de entrada e saída e notas adicionais.
Esse parâmetro não tem efeito sobre exibições de ajuda conceitual ("About_").
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Functionality <string[]>
Exibe ajuda para itens com a funcionalidade especificada. Insira a funcionalidade. Os caracteres curinga são permitidos.
Functionality é uma propriedade do objeto MamlCommandHelpInfo retornada por Get-Help. Esse parâmetro não tem efeito sobre exibições de ajuda conceitual ("About_").
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Name <string>
Solicita ajuda sobre a ferramenta especificada ou o tópico conceitual. Digite um nome de cmdlet, provedor, script ou função, como Get-Member, um nome de tópico conceitual, como "about_Objects", ou um alias, como "ls". Caracteres curinga são permitidos nos nomes de cmdlet e de provedor, mas você não pode usar caracteres curinga para localizar os nomes dos tópicos da Ajuda de função e script.
Para obter ajuda para um script que não está localizado em um caminho listado na variável de ambiente Path, digite o caminho e o nome de arquivo do script.
Se você inserir o nome exato de um tópico da ajuda, Get-Help exibirá os conteúdos desse tópico. Se você digitar uma palavra ou um padrão de palavras que aparece em vários títulos de tópico de ajuda, Get-Help exibirá uma lista de títulos correspondentes. Se você digitar uma palavra que não corresponda a qualquer título de tópico da ajuda, Get-Help exibirá uma lista de tópicos que incluem essa palavra em seus conteúdos.
Os nomes de tópicos conceituais, como about_Objects, devem ser digitados em inglês, mesmo em versões do Windows PowerShell que não sejam em inglês.
Necessário? |
false |
Posição? |
1 |
Valor padrão |
|
Aceitar entrada do pipeline? |
true (ByPropertyName) |
Aceitar caracteres curinga? |
false |
-Online
Exibe a versão online de um tópico da Ajuda no navegador padrão da Internet. Esse parâmetro é válido somente para os tópicos da Ajuda referentes a cmdlets, funções e scripts.
Get-Help usa o endereço na Internet (URI) que aparece no primeiro item da seção Links Relacionados de um cmdlet, uma função ou um tópico da Ajuda do script. Esse parâmetro funciona somente quando o tópico da Ajuda inclui um URI que começa com "Http" ou "Https" e há um navegador de Internet instalado no sistema.
Para obter informações sobre como oferecer suporte a esse recurso em tópicos da Ajuda redigidos por você, consulte about_comment_based_help e "How to Write Cmdlet Help" na Biblioteca MSDN, em https://go.microsoft.com/fwlink/?LinkID=123415.
Necessário? |
false |
Posição? |
named |
Valor padrão |
Nenhum |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Parameter <string>
Exibe apenas as descrições detalhadas dos parâmetros especificados. Os caracteres curinga são permitidos.
Esse parâmetro não tem efeito sobre exibições de ajuda conceitual ("About_").
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Path <string>
Obtém ajuda que explica como o cmdlet funciona no caminho de provedor especificado. Digite um caminho do provedor do Windows PowerShell.
Esse parâmetro obtém uma versão personalizada de um tópico da ajuda do cmdlet que explica como o cmdlet funciona no caminho do provedor do Windows PowerShell especificado. Esse parâmetro é eficiente apenas para obter ajuda sobre um cmdlet de provedor, e somente quando o provedor inclui uma versão personalizada do tópico da Ajuda do cmdlet de provedor.
Para ver a ajuda do cmdlet personalizado para um caminho do provedor, vá ao local do caminho do provedor e digite um comando Get-Help ou, de qualquer local de caminho, use o parâmetro Path de Get-Help para especificar o caminho do provedor. Para obter mais informações, consulte about_Providers.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Role <string[]>
Exibe ajuda personalizada para a função de usuário especificada. Insira uma função. Os caracteres curinga são permitidos.
Digite a função que o usuário executa em uma organização. Alguns cmdlets exibem texto diferente em seus arquivos de ajuda com base no valor desse parâmetro. Esse parâmetro não tem efeito na ajuda para os cmdlets de núcleo.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
<CommonParameters>
Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.
Entradas e saídas
O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.
Entradas |
Nenhum Você não pode canalizar objetos para este cmdlet. |
Saídas |
System.String ou MamlCommandHelpInfo Se você solicitar um tópico conceitual, Get-Help o retornará como uma cadeia de caracteres. Se você especificar o nome de um cmdlet, de uma função ou de um script, ele retornará um objeto MamlCommandHelpInfo. Caso contrário, Get-Help retornará uma das exibições formatadas que são especificadas no arquivo Help.Format.ps1xml no diretório $pshome. |
Observações
Sem parâmetros, "Get-Help" exibe informações sobre o sistema de ajuda do Windows PowerShell.
A exibição completa da Ajuda (-full) inclui uma tabela de informações sobre os parâmetros. A tabela inclui os seguintes campos:
-- Necessário: Indica se o parâmetro é necessário (true) ou opcional (false).
-- Posição: Indica se o parâmetro é nomeado ou posicional (numerado). Os parâmetros posicionais devem aparecem em um local especificado no comando.
-- "Nomeado" indica que o nome do parâmetro é necessário, mas que o parâmetro pode aparecer em qualquer lugar no comando.
-- <Number> indica que o nome do parâmetro é opcional, mas quando o nome é omitido, o parâmetro deve estar no local especificado pelo número. Por exemplo, "2" indica que quando o nome do parâmetro é omitido, o parâmetro deve ser o segundo (2) ou apenas um parâmetro não nomeado no comando. Quando o nome do parâmetro for utilizado, o parâmetro poderá aparecer em qualquer lugar no comando.
-- Valor padrão: O valor do parâmetro que o Windows PowerShell utilizará se você não incluir o parâmetro no comando.
-- Aceita entrada do pipeline: Indica se você pode (true) ou não pode (false) enviar objetos ao parâmetro por meio de um pipeline. "Por Nome de Propriedade" significa que o objeto enviado deve ter uma propriedade com o mesmo nome que o parâmetro.
-- Aceita caracteres curinga: Indica se o valor de um parâmetro pode incluir caracteres curinga, como * e ?.
Exemplo 1
C:\PS>get-help
Descrição
-----------
Esse comando exibe ajuda sobre o sistema de ajuda do Windows PowerShell.
Exemplo 2
C:\PS>get-help *
Descrição
-----------
Esse comando exibe uma lista de todos os arquivos de ajuda do sistema de ajuda do Windows PowerShell.
Exemplo 3
C:\PS>get-help get-alias
C:\PS>help get-alias
C:\PS>get-alias -?
Descrição
-----------
Esses comandos exibem informações básicas sobre o cmdlet get-alias. Os comandos "Get-Help" e "-?" exibem as informações em uma única página. O comando "Help" exibe as informações em uma página de cada vez.
Exemplo 4
C:\PS>get-help about_*
Descrição
-----------
Esse comando exibe uma lista dos tópicos conceituais incluídos na ajuda do Windows PowerShell. Todos esses tópicos começam com os caracteres "about_". Para exibir um arquivo de ajuda específico, digite "get-help <nome-do-tópico>, por exemplo, "get-help about_signing".
Exemplo 5
C:\PS>get-help ls -detailed
Descrição
-----------
Esse comando exibe ajuda detalhada para o cmdlet Get-ChildItem especificando um de seus aliases, "ls". O parâmetro Detailed pede a exibição detalhada do arquivo de ajuda, que inclui descrições de parâmetro e exemplos. Para ver o arquivo de ajuda completo de um cmdlet, utilize o parâmetro Full.
Exemplo 6
C:\PS>get-help format-string -full
Descrição
-----------
Esse comando exibe a ajuda de exibição completa para o cmdlet Format-String. A exibição completa da ajuda inclui descrições de parâmetros, exemplos e uma tabela de detalhes técnicos sobre os parâmetros.
Exemplo 7
C:\PS>get-help start-service -examples
Descrição
-----------
Esse comando exibe exemplos de uso de start-service em comandos do Windows PowerShell.
Exemplo 8
C:\PS>get-help get-childitem -parameter f*
Descrição
-----------
Esse comando exibe descrições dos parâmetros do cmdlet Get-ChildItem que começam com “f” (filter e force) Para descrições de todos os parâmetros, digite "get-help get-childitem parameter*".
Exemplo 9
C:\PS>(get-help write-output).syntax
Descrição
-----------
Esse comando exibe apenas a sintaxe do cmdlet Write-Output.
A sintaxe é uma das muitas propriedades de objetos de ajuda; outras são descrição, detalhes, exemplos e parâmetros. Para localizar todas as propriedades e os métodos dos objetos de ajuda, digite "get-help <nome-do-cmdlet> | get-member", por exemplo, "get-help start-service | get member".
Exemplo 10
C:\PS>(get-help trace-command).alertset
Descrição
-----------
Esse comando exibe as notas sobre o cmdlet. As notas são armazenadas na propriedade alertSet do objeto de ajuda.
As notas incluem informações conceituais e dicas para usar o cmdlet. Por padrão, as notas são exibidas apenas quando você usa o parâmetro Full de Get-Help, mas você também pode exibi-los com o uso da propriedade alertSet.
Exemplo 11
C:\PS>get-help add-member -full | out-string -stream | select-string -pattern clixml
Descrição
-----------
Esse exemplo mostra como pesquisar uma palavra em um tópico de ajuda específico de cmdlet. Esse comando pesquisa a palavra "clixml" na versão completa do tópico de ajuda do cmdlet Add-Member.
Como o cmdlet Get-Help gera um objeto MamlCommandHelpInfo, não uma cadeia de caracteres, você precisa usar um comando que transforme o conteúdo do tópico da Ajuda em uma cadeia de caracteres, como Out-String ou Out-File.
Exemplo 12
C:\PS>get-help get-member -online
Descrição
-----------
Esse comando exibe a versão online do tópico de ajuda do cmdlet Get-Member.
Exemplo 13
C:\PS>get-help remoting
Descrição
-----------
Esse comando exibe uma lista de tópicos que incluem a palavra "remoting" em seu conteúdo.
Quando você digita uma palavra que não aparece em nenhum título de tópico, Get-Help exibe uma lista de tópicos que inclui essa palavra.
Exemplo 14
C:\PS>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.
...
C:\PS> cd SQLSERVER:\DataCollection
C:\PS> 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.
...
C:\PS> Get-Item
NAME
Get-Item
SYNOPSIS
Gets the item at the specified location.
...
Descrição
-----------
Esse exemplo mostra como obter ajuda para o cmdlet Get-Item que explica como usar o cmdlet no nó DataCollection do provedor Windows PowerShell SQL Server.
O exemplo mostra dois modos de obter a ajuda personalizada para Get-Item.
O primeiro comando utiliza o parâmetro Path de Get-Help para especificar o caminho do provedor. Esse comando pode ser inserido em qualquer local de caminho.
O segundo comando usa o cmdlet Set-Location (alias = "cd") para ir até o caminho do provedor. Nesse local, mesmo sem o parâmetro Path, o comando Get-Help obtém a ajuda personalizada para o caminho do provedor.
O terceiro comando mostra que um comando Get-Help em um caminho do sistema de arquivos, e sem o parâmetro Path, obtém a ajuda padrão para o cmdlet Get-Item.
Exemplo 15
C:\PS>get-help c:\ps-test\MyScript.ps1
Descrição
-----------
Esse comando obtém ajuda para o script MyScript.ps1. Para obter informações sobre como escrever ajuda para suas funções e scripts, consulte about_Comment_Based_Help.