Comando Get-Help: Sintaxe, Parâmetros, Exemplos
Procurar tópicos de postagem
- Introdução
- Sintaxe do comando Get-Help do Powershell
- Parâmetros de ajuda do Powershell
- Exemplos de ajuda do Powershell
- Exemplo 1 do Powershell Get-Help: Ajuda básica do Powershell
- Exemplo 2 do Powershell Get-Help: Ajuda detalhada e completa do Powershell
- Exemplo 3 de ajuda do Powershell: ajuda on-line do Powershell
- Exemplo 4 do Powershell Get-Help: Categoria Powershell Help
- Exemplo 5 do Powershell Get-Help: obter exemplos de um cmdlet
- Conclusão
- Outros guias úteis
- Recursos e referências adicionais
Introdução
Não sabe como usar um cmdlet do PowerShell? O cmdlet Get-Help do PowerShell fornecerá informações sobre qualquer comando do PowerShell.
Neste guia, você aprenderá a usar o cmdlet Get-Help do PowerShell. Sua sintaxe, parâmetros e alguns exemplos.
vantagens de nível de perfil do Steam
Sintaxe do comando Get-Help do Powershell
A sintaxe simplificada do Powershell Get-Help é:
|_+_| Alguns parâmetros do cmdlet Get-Help do Powershell não são mostrados acima. Eu apenas listei os parâmetros que você precisará para o uso diário. O cmdlet Get-Help pode fornecer informações de ajuda do PowerShell para cmdlets, funções, comandos CIM, fluxos de trabalho, provedores, aliases e scripts.
Parâmetros de ajuda do Powershell
A tabela abaixo lista os parâmetros mostrados na última seção e o que eles significam. Também inclui exemplos. Para obter exemplos detalhados, consulte os Exemplos mais adiante no guia.
| S/N | Parâmetro | Significado | Exemplo de ajuda do Powershell |
| 1 | Nome | Especifica o nome do cmdlet, função, script, fluxo de trabalho, provedor ou alias | Get-Help -Name Get-Command |
| dois | Parâmetro | Usado para especificar um parâmetro do cmdlet para o qual você precisa obter ajuda | Get-Help -Name Get-Command -Nome do parâmetro |
| 3 | Exemplos | Este parâmetro não requer um valor de entrada. Se especificado, Get-Help retornará exemplos para o cmdlet | Get-Help -Name Get-Command -Exemplos |
| 4 | Categoria | Exibe ajuda apenas para itens na categoria especificada e seus aliases. Alguns valores aceitos: Alias, Cmdlet, etc | Obter-Ajuda - Alias da Categoria |
| 5 | Completo | Exibe todo o tópico de ajuda de um cmdlet, incluindo parâmetros, atributos e exemplos | Get-Help Get-Command -Completo |
| 6 | Detalhado | Adiciona descrições de parâmetros e exemplos à tela de ajuda básica. | Get-Help Get-Command -Detalhado |
| 7 | Conectados | Abre a versão online de um tópico de ajuda no navegador de Internet padrão | Get-Help Get-Command -Online |
Exemplos de ajuda do Powershell
Aqui estão alguns exemplos do cmdlet Get-Help do PowerShell. Nesta seção, usarei Get-Help para obter informações sobre o cmdlet Get-Command.
Exemplo 1 do Powershell Get-Help: Ajuda básica do Powershell
Para obter as informações básicas de ajuda sobre o cmdlet Get-Command, execute o comando abaixo:
|_+_|
Neste exemplo, o cmdlet é Get-Command . Observe que não incluí o parâmetro -Name. Não precisa ser incluído. Aqui está o resultado do comando no PowerShell.
O comando retornou SINOPSE (descrição do cmdlet), sua SINTAXE (como usar o cmdlet) e seu DESCRIÇÃO (informações detalhadas sobre o cmdlet).
Exemplo 2 do Powershell Get-Help: Ajuda detalhada e completa do Powershell
Para exibir informações mais detalhadas sobre um cmdlet, basta incluir o Detalhado parâmetro. Aqui está o exemplo modificado.
|_+_|Ao incluir o Detalhado parâmetro, Get-Help adiciona descrições de parâmetros e exemplos às informações básicas de ajuda do PowerShell.
A maioria das informações não é mostrada na imagem anterior.Além disso, se você deseja exibir todas as informações de ajuda sobre o cmdlet, use o Completo parâmetro.
Aqui está um comando de exemplo:
|_+_|
Exemplo 3 de ajuda do Powershell: ajuda on-line do Powershell
Se quiser que Get-Help abra a ajuda online do cmdlet, use o Conectados parâmetro. Get-Help abrirá as informações de ajuda do cmdlet usando seu navegador padrão.
Aqui está o comando para exibir as informações online do cmdlet Get-Command.
|_+_|Aqui está o resultado. Aberto no Chrome (meu navegador padrão):
Exemplo 4 do Powershell Get-Help: Categoria Powershell Help
O comando Get-Help tem um parâmetro chamado Categoria . Você pode usar isso para obter informações de ajuda sobre qualquer uma das seguintes categorias:
Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class and Configuration
Uma aplicação muito útil disso é exibir uma lista completa dos Aliases de todos os cmdlets do PowerShell em seu computador.
root galaxy s6 at & t 5.1.1
Aqui está o comando:
|_+_|E o resultado…
tamanho da pasta do Google Drive
Usar aliases de cmdlet encurta seu script. Da próxima vez que estiver criando scripts, você poderá obter os aliases dos cmdlets usando o comando acima.Em outro exemplo, para retornar TODOS os cmdlets do seu computador, use o comando abaixo:
|_+_|Se você precisar de cmdlets específicos, poderá usar o cmdlet Where-Object para devolvê-los.
Por exemplo, para retornar comandos que começam com as palavras O que , use o comando abaixo
|_+_|Isso retornará os cmdlets próximos ao que eu quero. Veja os resultados abaixo:
Exemplo 5 do Powershell Get-Help: obter exemplos de um cmdlet
Um dos benefícios do comando Get-Help do Powershell é que ele pode fornecer exemplos de como usar um cmdlet.
Para exibir exemplos de como usar Get-Command, use o comando abaixo:
|_+_|O comando exibe todos os exemplos disponíveis:
Conclusão
Espero que este guia simplifique como usar o Powershell Get-Help para você. Mais importante, espero que você tenha escolhido uma ou duas coisas que você precisa para escrever seu próximo script do PowerShell.
Se você tiver alguma pergunta ou comentário, use o formulário Deixe uma resposta no final desta página. Você também pode compartilhar sua experiência pessoal com o PowerShell.
Para saber mais sobre o powershell, visite nossa página do PowerShell. Você também pode pesquisar o PowerShell para listar todos os nossos guias do PowerShell.
Outros guias úteis
- 18 comandos Powershell mais úteis para administradores do Windows
- Como agendar um script do PowerShell para execução automática em um servidor Windows
