Partilhar via

Get-Help

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

Exibe informações sobre 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 Get-Help cmdlet exibe informações sobre 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 do nome do cmdlet, como: Get-Help Get-Process.

Os artigos de ajuda conceitual no PowerShell começam com about_, como about_Comparison_Operators. Para ver todos os about_ artigos, 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 do nome do provedor. Por exemplo, para obter ajuda para o provedor de certificado, digite Get-Help Certificate.

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

Get-Help Obtém o conteúdo da Ajuda que ele exibe dos arquivos de Ajuda no 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 acompanham 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 Update-Help cmdlet.

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 do nome exato de um artigo de ajuda ou de uma palavra exclusiva de 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 palavras que aparece em vários títulos de artigos de ajuda, Get-Help exibirá uma lista dos 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 obter artigos de ajuda para todos os idiomas e localidades suportados. Get-Help primeiro procura arquivos de ajuda na localidade definida para Windows, depois na localidade pai, como pt para pt-BR e, em seguida, 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 a ajuda gerada automaticamente.

Para obter informações sobre os símbolos exibidos Get-Help 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, não é possível encontrar Sobre artigos em módulos, Get-Help a menos que o módulo seja importado para a sessão atual. Para obter Sobre artigos em um módulo, importe o módulo usando o Import-Module cmdlet ou executando um cmdlet incluído no módulo.

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

Quando você pressiona a tecla F1, a função PSReadLine ShowCommandHelp é chamada Get-Help -Full para o nome do cmdlet mais próximo à esquerda do cursor. Quando o cursor está 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ê pressiona Q para sair da exibição de ajuda, você retorna à linha de comando na mesma posição do cursor para que possa continuar digitando o comando.

Quando você usa a combinação de teclas Alt+h, a função PSReadLine ShowParameterHelp exibe informações de ajuda para o parâmetro imediatamente à esquerda do cursor. O texto de 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 Usando 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 Format-Table cmdlet.

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

Get-Help <cmdlet-name> é a sintaxe mais simples e padrão do Get-Help cmdlet. 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

Estes exemplos exibem informações básicas de ajuda sobre o Format-Table cmdlet, 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 o cmdlet internamente e exibe o resultado uma página de cada vez.

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

Get-Help Format-Table envia o objeto pelo pipeline. Out-Host -Paging recebe a saída do pipeline e a 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 Format-Table cmdlet.

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

O parâmetro Detailed exibe a exibição detalhada do artigo de ajuda que inclui descrições de parâmetros e exemplos.

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

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

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

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

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 Examples. Não é possível especificar um número Example porque o parâmetro Examples é um parâmetro switch.

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, as 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 para o Format-Table cmdlet em seu navegador da Web padrão.

Get-Help Format-Table -Online

Exemplo 6: Exibir ajuda sobre o sistema de ajuda

O Get-Help cmdlet 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 no 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 personagens 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 no 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

Este exemplo mostra como pesquisar uma palavra em um artigo de ajuda do 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 informações de ajuda para Add-Membero . O objeto MamlCommandHelpInfo é enviado pelo pipeline. Out-String usa o parâmetro Stream para converter o objeto em uma cadeia de caracteres. Select-Stringusa o parâmetro Pattern para pesquisar Clixml na cadeia de caracteres.

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

Este exemplo exibe uma lista de artigos que incluem a palavra comunicação remota.

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: Ajuda específica do provedor de exibição

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

O primeiro exemplo usa o Get-Help parâmetro Path 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. A partir desse local, o parâmetro Path não é necessário para Get-Help obter 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

Este exemplo obtém ajuda para o MyScript.ps1 script. Para obter informações sobre como escrever ajuda para suas 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 este parâmetro são os seguintes:

  • Alias
  • Cmdlet
  • Provider
  • Geral
  • FAQ
  • Glossário
  • Ficheiro de Ajuda
  • ScriptCommand
  • Function
  • Filtro
  • ExternalScript
  • Todos
  • DefaultHelp
  • Fluxo de Trabalho
  • DscResource
  • Classe
  • Configuração
Tipo:String[]
Valores aceites:Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Component

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

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:True

-Detailed

Adiciona descrições de parâmetros e exemplos à exibição de ajuda básica. Este parâmetro só é eficaz quando os ficheiros de ajuda estão instalados no computador. Não tem efeito sobre exibições de ajuda conceitual (About_).

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

-Examples

Exibe apenas o nome, a sinopse e os exemplos. Este parâmetro só é eficaz quando os ficheiros de ajuda estão instalados no computador. Não tem efeito sobre exibições de ajuda conceitual (About_).

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

-Full

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

Este parâmetro só é eficaz quando os ficheiros de ajuda estão instalados no computador. Não tem efeito sobre exibições de ajuda conceitual (About_).

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

-Functionality

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

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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_Objects, ou um alias, como ls. Caracteres curinga são permitidos em nomes de cmdlets e provedores, mas você não pode usar caracteres curinga para localizar os nomes de artigos de ajuda de função e de script.

Para obter ajuda para um script que não está localizado em um caminho listado $env:Path na variável de ambiente, 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 palavras que aparece em vários títulos de artigos de ajuda, Get-Help exibirá uma lista dos 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 inglesas do PowerShell.

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

-Online

Exibe a versão online de um artigo de ajuda no navegador padrão. Esse parâmetro é válido apenas para cmdlet, função, fluxo de trabalho e artigos de ajuda de script. Não é possível 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 à Ajuda Online e Escrevendo Ajuda para cmdlets do PowerShell.

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

-Parameter

Exibe apenas as descrições detalhadas dos parâmetros especificados. Curingas são permitidos. Este parâmetro não tem efeito sobre exibições de ajuda conceitual (About_).

Tipo:String[]
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:True

-Path

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

Este parâmetro obtém uma versão personalizada de um artigo de ajuda do cmdlet que explica como o cmdlet funciona no caminho do provedor do PowerShell especificado. Esse parâmetro só é eficaz para obter ajuda sobre um cmdlet do 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 do provedor, vá para o local do caminho do provedor e insira um Get-Help comando ou, de qualquer local do caminho, use o parâmetro Path de para especificar o caminho do Get-Help provedor. Você também pode encontrar ajuda personalizada do cmdlet online na seção de ajuda do provedor dos artigos de ajuda.

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

Nota

O provedor para o 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
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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. Esse parâmetro não tem efeito na ajuda para os cmdlets principais.

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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 Configurações que permite definir opções para a exibição, incluindo opções para exibir apenas seções selecionadas de um tópico da ajuda.

O parâmetro ShowWindow suporta tópicos de ajuda para comandos (cmdlets, funções, comandos CIM, scripts) e artigos conceituais Sobre . Ele não suporta a ajuda do provedor.

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

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

Entradas

None

Não é possível canalizar 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 retorna-o como uma cadeia de caracteres.

MamlCommandHelpInfo

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

Notas

O PowerShell 3.0 não inclui arquivos de ajuda. Para baixar e instalar os arquivos de ajuda lidos Get-Help , use o Update-Help cmdlet. Você pode usar o Update-Help cmdlet para baixar e instalar arquivos de ajuda para os comandos principais que vêm com o PowerShell e para quaisquer módulos instalados. Você também pode usá-lo para atualizar os arquivos de ajuda para que a ajuda no 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 a ajuda na localidade definida para o sistema operacional Windows ou no idioma de fallback para essa localidade. Se você não tiver arquivos de ajuda para a localidade principal 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 Região e Idioma no Painel de Controle para alterar as configurações. No Windows 10 ou superior, Configurações, Hora e Idioma.

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

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

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

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

  • Numérico indica que o nome do parâmetro é opcional, mas quando o nome é omitido, o parâmetro deve estar no lugar especificado 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. By Property Name significa que o objeto pipelined 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 ponto de interrogação (?).