Get-Help

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

C:\PS>get-help

Descrição
-----------
Esse comando exibe ajuda sobre o sistema de ajuda do Windows PowerShell.

C:\PS>get-help *

Descrição
-----------
Esse comando exibe uma lista de todos os arquivos de ajuda do sistema de ajuda do Windows PowerShell.

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.

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

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.

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.

C:\PS>get-help start-service -examples

Descrição
-----------
Esse comando exibe exemplos de uso de start-service em comandos do Windows PowerShell.

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

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

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.

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.

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.

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.

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.

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.