Compartilhar via

Verbos aprovados para comandos do PowerShell

  • Artigo

O PowerShell usa um par verbo-substantivo para os nomes de cmdlets e as respectivas classes .NET derivadas. A parte do nome correspondente ao verbo identifica a ação que o cmdlet executa. A parte do nome correspondente ao substantivo identifica a entidade sobre a qual a ação é executada. Por exemplo, o cmdlet Get-Command recupera todos os comandos registrados no PowerShell.

Observação

O PowerShell usa o termo verbo para descrever uma palavra que implica uma ação, mesmo que essa palavra não seja um verbo padrão no idioma inglês. Por exemplo, o termo New é um nome de verbo válido do PowerShell porque implica uma ação, embora não seja um verbo no idioma inglês.

Cada verbo aprovado tem um prefixo de alias correspondente definido. Usamos esse prefixo de alias em aliases para comandos que usam esse verbo. Por exemplo, o prefixo do alias para Import é ip e, dessa maneira, o alias para Import-Module é ipmo. Essa é uma recomendação, mas não uma regra; em particular, ela não precisa ser respeitada para aliases de comando que imitam comandos conhecidos de outros ambientes.

Recomendações de nomenclatura de verbo

As recomendações a seguir ajudam a escolher um verbo apropriado para o cmdlet, a fim de garantir a consistência entre os cmdlets criados por você, os cmdlets fornecidos pelo PowerShell e os cmdlets criados por outras pessoas.

  • Use um dos nomes de verbo predefinidos fornecidos pelo PowerShell
  • Use o verbo para descrever o escopo geral da ação e parâmetros para refinar ainda mais a ação do cmdlet.
  • Não use um sinônimo de um verbo aprovado. Por exemplo, sempre use Remove; nunca use Delete nem Eliminate.
  • Use apenas a forma de cada verbo listada neste tópico. Por exemplo, use Get, mas não use Getting nem Gets.
  • Não use os aliases ou verbos reservados a seguir. A linguagem do PowerShell e alguns poucos cmdlets usam esses verbos em circunstâncias excepcionais.
    • ForEach (foreach)
    • Ping (pi)
    • Sort (sr)
    • Tee (te)
    • Where (wh)

Você pode obter uma lista completa de verbos usando o cmdlet Get-Verb.

Verbos semelhantes para ações diferentes

Os verbos semelhantes a seguir representam ações diferentes.

Novo vs. Adicionar

Use o verbo New para criar um recurso. Use o Add para adicionar algo a um contêiner ou recurso existente. Por exemplo, Add-Content adiciona a saída a um arquivo existente.

New versus Definir

Use o verbo New para criar um recurso. Use o verbo Set para modificar um recurso existente, criando-o opcionalmente se ele não existir, como o cmdlet Set-Variable.

Use o verbo Find para procurar um objeto. Use o verbo Search para criar uma referência a um recurso em um contêiner.

Get versus Ler

Use o verbo Get para obter informações sobre um recurso (como um arquivo) ou para obter um objeto com o qual você pode acessar o recurso no futuro. Use o Read verbo para abrir um recurso e extrair informações contidas nele.

Invoke versus Iniciar

Use o verbo Invoke para executar operações síncronas, como executar um comando e aguardar a conclusão dele. Use o Start verbo para iniciar operações assíncronas, como iniciar um processo autônomo.

Ping versus Teste

Use o verbo Test.

Verbos comuns

O PowerShell usa a classe de enumeração System.Management.Automation.VerbsCommon para definir ações genéricas que podem ser aplicadas a quase qualquer cmdlet. A tabela a seguir lista a maioria dos verbos definidos.

Verbo (alias) Ação Sinônimos a serem evitados
Add (a) Adiciona um recurso a um contêiner ou anexa um item a outro item. Por exemplo, o cmdlet Add-Content adiciona o conteúdo a um arquivo. Esse verbo é emparelhado com Remove. Append, Attach, Concatenate, Insert
Clear (cl) Remove todos os objetos de um contêiner, mas não o exclui. Por exemplo, o cmdlet Clear-Content remove o conteúdo de um arquivo, mas não exclui o arquivo. Flush, Erase, Release, Unmark, Unset, Nullify
Close (cs) Altera o estado de um recurso para torná-lo inacessível, indisponível ou inutilizável. Esse verbo é emparelhado com Open.
Copy (cp) Copia um recurso para outro nome ou para outro contêiner. Por exemplo, o cmdlet Copy-Item copia um item (como um arquivo) de um local no armazenamento de dados para outro local. Duplicate, Clone, Replicate, Sync
Enter (et) Especifica uma ação que permite ao usuário se mover para um recurso. Por exemplo, o cmdlet Enter-PSSession coloca o usuário em uma sessão interativa. Esse verbo é emparelhado com Exit. Push, Into
Exit (ex) Define o ambiente ou contexto atual como o contexto usado mais recentemente. Por exemplo, o cmdlet Exit-PSSession coloca o usuário na sessão que foi usada para iniciar a sessão interativa. Esse verbo é emparelhado com Enter. Pop, Out
Find (fd) Procura um objeto em um contêiner que é desconhecido, implícito, opcional ou especificado. Search
Formato (f) Organiza objetos em um formulário ou layout especificado
Get (g) Especifica uma ação que recupera um recurso. Esse verbo é emparelhado com Set. Read, Open, Cat, Type, Dir, Obtain, Dump, Acquire, Examine, Find, Search
Hide (h) Torna um recurso não detectável. Por exemplo, um cmdlet cujo nome inclui o verbo Hide pode ocultar um serviço de um usuário. Esse verbo é emparelhado com Show. Bloquear
Join (j) Combina recursos em um recurso. Por exemplo, o cmdlet Join-Path combina um caminho com um dos caminhos filho dele para criar um único caminho. Esse verbo é emparelhado com Split. Combine, Unite, Connect, Associate
Lock (lk) Protege um recurso. Esse verbo é emparelhado com Unlock. Restrict, Secure
Move (m) Move um recurso de um local para outro. Por exemplo, o cmdlet Move-Item move um item de um local no armazenamento de dados para outro local. Transfer, Name, Migrate
New (n) Cria um recurso. (O verbo Set também pode ser usado durante a criação de um recurso que inclui dados, como o cmdlet Set-Variable.) Create, Generate, Build, Make, Allocate
Open (op) Altera o estado de um recurso para torná-lo acessível, disponível ou utilizável. Esse verbo é emparelhado com Close.
Optimize (om) Aumenta a eficácia de um recurso.
Pop (pop) Remove um item do tipo de uma pilha. Por exemplo, o cmdlet Pop-Location altera o local atual para o local mais recentemente inserido na pilha.
Push (pu) Adiciona um item ao tipo de uma pilha. Por exemplo, o cmdlet Push-Location envia o local atual para cima da pilha.
Redo (re) Redefine um recurso para o estado desfeito.
Remove (r) Exclui um recurso de um contêiner. Por exemplo, o cmdlet Remove-Variable exclui uma variável e o valor dela. Esse verbo é emparelhado com Add. Clear, Cut, Dispose, Discard, Erase
Rename (rn) Altera o nome de um recurso. Por exemplo, o cmdlet Rename-Item, que é usado para acessar dados armazenados, altera o nome de um item no armazenamento de dados. Alterar
Reset (rs) Define um recurso para o estado original dele.
Resize(rz) Altera o tamanho de um recurso.
Search (sr) Cria uma referência a um recurso em um contêiner. Find, Locate
Select (sc) Localiza um recurso em um contêiner. Por exemplo, o cmdlet Select-String localiza texto em cadeias de caracteres e arquivos. Find, Locate
Set (s) Substitui dados em um recurso existente ou cria um recurso que contém alguns dados. Por exemplo, o cmdlet Set-Date altera a hora do sistema no computador local. (O verbo New também pode ser usado para criar um recurso.) Esse verbo é emparelhado com Get. Write, Reset, Assign, Configure
Show (sh) Torna um recurso visível para o usuário. Esse verbo é emparelhado com Hide. Display, Produce
Skip (sk) Ignora um ou mais recursos ou pontos em uma sequência. Bypass, Jump
Split (sl) Separa partes de um recurso. Por exemplo, o cmdlet Split-Path retorna partes diferentes de um caminho. Esse verbo é emparelhado com Join. Separate
Step (st) Passa para o próximo ponto ou recurso em uma sequência.
Switch (sw) Especifica uma ação que alterna entre dois recursos, como alterar entre dois locais, responsabilidades ou estados.
Undo (un) Define um recurso para o estado anterior dele.
Unlock (uk) Libera um recurso que estava bloqueado. Esse verbo é emparelhado com Lock. Release, Unrestrict, Unsecure
Watch (wc) Inspeciona ou monitora continuamente um recurso em busca de alterações.

Verbos de comunicações

O PowerShell usa a classe System.Management.Automation.VerbsCommunications para definir as ações que se aplicam a comunicações. A tabela a seguir lista a maioria dos verbos definidos.

Verbo (alias) Ação Sinônimos a serem evitados
Connect (cc) Cria um vínculo entre uma origem e um destino. Esse verbo é emparelhado com Disconnect. Join, Telnet
Disconnect (dc) Interrompe o vínculo entre uma origem e um destino. Esse verbo é emparelhado com Connect. Break, Logoff
Read (rd) Adquire informações de uma origem. Esse verbo é emparelhado com Write. Acquire, Prompt, Get
Receive (rc) Aceita informações enviadas de uma origem. Esse verbo é emparelhado com Send. Read, Accept, Peek
Send (sd) Entrega as informações para um destino. Esse verbo é emparelhado com Receive. Put, Broadcast, Mail, Fax
Write (wr) Adiciona informações a um destino. Esse verbo é emparelhado com Read. Put, Print

Verbos de dados

O PowerShell usa a classe System.Management.Automation.VerbsData para definir as ações que se aplicam à manipulação de dados. A tabela a seguir lista a maioria dos verbos definidos.

Nome do verbo (alias) Ação Sinônimos a serem evitados
Backup (ba) Armazena dados replicando-os. Save, Burn, Replicate, Sync
Checkpoint (ch) Cria um instantâneo do estado atual dos dados ou da configuração deles. Diff
Compare (cr) Avalia os dados de um recurso em relação aos dados de outro recurso. Diff
Compress (cm) Compacta os dados de um recurso. Faz o emparelhamento com Expand. Compacto
Convert (cv) Altera os dados de uma representação para outra quando o cmdlet dá suporte à conversão bidirecional ou quando o cmdlet dá suporte à conversão entre vários tipos de dados. Change, Resize, Resample
ConvertFrom (cf) Converte um tipo principal de entrada (o substantivo do cmdlet indica a entrada) em um ou mais tipos de saída com suporte. Export, Output, Out
ConvertTo (ct) Converte de um ou mais tipos de entrada em um tipo de saída primário (o substantivo do cmdlet indica o tipo de saída). Import, Input, In
Dismount (dm) Desanexa uma entidade nomeada de um local. Esse verbo é emparelhado com Mount. Unmount, Unlink
Edit (ed) Modifica os dados existentes adicionando ou removendo o conteúdo. Change, Update, Modify
Expand (en) Restaura os dados de um recurso que foi compactado para o estado original dele. Esse verbo é emparelhado com Compress. Explode, Uncompress
Export (ep) Encapsula a entrada primária em um armazenamento de dados persistente, como um arquivo, ou em um formato de intercâmbio. Esse verbo é emparelhado com Import. Extract, Backup
Grupo (gp) Organiza ou associa um ou mais recursos
Import (ip) Cria um recurso com base nos dados armazenados em um armazenamento de dados persistente (como um arquivo) ou em um formato de intercâmbio. Por exemplo, o cmdlet Import-CSV importa dados de um arquivo CSV (valores separados por vírgula) para objetos que podem ser usados por outros cmdlets. Esse verbo é emparelhado com Export. BulkLoad, Load
Initialize (in) Prepara um recurso para uso e o define como um estado padrão. Erase, Init, Renew, Rebuild, Reinitialize, Setup
Limit (l) Aplica restrições a um recurso. Quota
Merge (mg) Cria um recurso de vários recursos. Combine, Join
Mount (mt) Anexa uma entidade nomeada a um local. Esse verbo é emparelhado com Dismount. Conectar
Out (o) Envia dados para fora do ambiente. Por exemplo, o cmdlet Out-Printer envia dados para uma impressora.
Publish (pb) Disponibiliza um recurso para outras pessoas. Esse verbo é emparelhado com Unpublish. Deploy, Release, Install
Restore (rr) Define um recurso para um estado predefinido, como um estado definido por Checkpoint. Por exemplo, o cmdlet Restore-Computer inicia uma restauração do sistema no computador local. Repair, Return, Undo, Fix
Save (sv) Preserva os dados para evitar perda.
Sync (sy) Garante que dois ou mais recursos estejam no mesmo estado. Replicate, Coerce, Match
Unpublish (ub) Torna um recurso indisponível para outras pessoas. Esse verbo é emparelhado com Publish. Uninstall, Revert, Hide
Update (ud) Atualiza um recurso para manter o estado, a precisão ou a conformidade dele. Por exemplo, o cmdlet Update-FormatData atualiza e adiciona arquivos de formatação ao console do PowerShell atual. Refresh, Renew, Recalculate, Re-index

Verbos de diagnóstico

O PowerShell usa a classe System.Management.Automation.VerbsDiagnostic para definir as ações que se aplicam ao diagnóstico. A tabela a seguir lista a maioria dos verbos definidos.

Verbo (alias) Ação Sinônimos a serem evitados
Debug (db) Examina um recurso para diagnosticar problemas operacionais. Diagnosticar
Measure (ms) Identifica os recursos que são consumidos por uma operação especificada ou recupera estatísticas sobre um recurso. Calculate, Determine, Analyze
Ping (pi) Preterido – use o verbo Test em vez disso.
Repair (rp) Restaura um recurso para uma condição utilizável Fix, Restore
Resolve (rv) Mapeia uma representação abreviada de um recurso para uma representação mais completa. Expand, Determine
Test (t) Verifica a operação ou a consistência de um recurso. Diagnose, Analyze, Salvage, Verify
Trace (tr) Controla as atividades de um recurso. Track, Follow, Inspect, Dig

Verbos de ciclo de vida

O PowerShell usa a classe System.Management.Automation.VerbsLifeCycle para definir as ações que se aplicam ao ciclo de vida de um recurso. A tabela a seguir lista a maioria dos verbos definidos.

Verbo (alias) Ação Sinônimos a serem evitados
Approve (ap) Confirma o status de um recurso ou processo ou concorda com ele.
Assert (as) Afirma o estado de um recurso. Certify
Build (bd) Cria um artefato (geralmente um binário ou documento) de algum conjunto de arquivos de entrada (geralmente código-fonte ou documentos declarativos). O verbo foi adicionado no PowerShell 6.
Complete (cp) Conclui uma operação.
Confirm (cn) Reconhece, verifica ou valida o estado de um recurso ou processo. Acknowledge, Agree, Certify, Validate, Verify
Deny (dn) Recusa ou bloqueia o estado de um recurso ou processo ou faz objeção ou oposição a ele. Block, Object, Refuse, Reject
Deploy (dp) Envia um aplicativo, site ou solução para um destino remoto de modo que um consumidor dessa solução possa acessá-lo após a conclusão da implantação. O verbo foi adicionado no PowerShell 6.
Disable (d) Configura um recurso para um estado indisponível ou inativo. Por exemplo, o cmdlet Disable-PSBreakpoint torna um ponto de interrupção inativo. Esse verbo é emparelhado com Enable. Halt, Hide
Enable (e) Configura um recurso para um estado disponível ou ativo. Por exemplo, o cmdlet Enable-PSBreakpoint torna um ponto de interrupção ativo. Esse verbo é emparelhado com Disable. Start, Begin
Install (is) Coloca um recurso em um local e, opcionalmente, o inicializa. Esse verbo é emparelhado com Uninstall. Instalação
Invoke (i) Executa uma ação, como executar um comando ou um método. Run, Start
Register (rg) Cria uma entrada para um recurso em um repositório, como um banco de dados. Esse verbo é emparelhado com Unregister.
Request (rq) Solicita um recurso ou permissões.
Restart (rt) Interrompe uma operação e a inicia novamente. Por exemplo, o cmdlet Restart-Service para e inicia um serviço. Reciclar
Resume (ru) Inicia uma operação que foi suspensa. Por exemplo, o cmdlet Resume-Service inicia um serviço que foi suspenso. Esse verbo é emparelhado com Suspend.
Start (sa) Inicia uma operação. Por exemplo, o cmdlet Start-Service inicia um serviço. Esse verbo é emparelhado com Stop. Launch, Initiate, Boot
Stop (sp) Descontinua uma atividade. Esse verbo é emparelhado com Start. End, Kill, Terminate, Cancel
Submit (sb) Apresenta um recurso para aprovação. Postar
Suspend (ss) Pausa uma atividade. Por exemplo, o cmdlet Suspend-Service pausa um serviço. Esse verbo é emparelhado com Resume. Pausar
Uninstall (us) Remove um recurso de um local indicado. Esse verbo é emparelhado com Install.
Unregister (ur) Remove a entrada de um recurso de um repositório. Esse verbo é emparelhado com Register. Remover
Wait (w) Pausa uma operação até que um evento especificado ocorra. Por exemplo, o cmdlet Wait-Job pausa as operações até que um ou mais dos trabalhos em segundo plano sejam concluídos. Sleep, Pause

Verbos de segurança

O PowerShell usa a classe System.Management.Automation.VerbsSecurity para definir as ações que se aplicam à segurança. A tabela a seguir lista a maioria dos verbos definidos.

Verbo (alias) Ação Sinônimos a serem evitados
Block (bl) Restringe o acesso a um recurso. Esse verbo é emparelhado com Unblock. Prevent, Limit, Deny
Grant (gr) Permite o acesso a um recurso. Esse verbo é emparelhado com Revoke. Allow, Enable
Protect (pt) Protege um recurso contra ataque ou perda. Esse verbo é emparelhado com Unprotect. Encrypt, Safeguard, Seal
Revoke (rk) Especifica uma ação que não permite o acesso a um recurso. Esse verbo é emparelhado com Grant. Remove, Disable
Unblock (ul) Remove as restrições a um recurso. Esse verbo é emparelhado com Block. Clear, Allow
Unprotect (up) Remove as proteções de um recurso que foram adicionadas para evitar ataques ou perdas. Esse verbo é emparelhado com Protect. Decrypt, Unseal

Outros verbos

O PowerShell usa a classe System.Management.Automation.VerbsOther para definir nomes de verbo canônicos não adequados a uma categoria de nome de verbo específica, como os verbos de nomes comuns, de comunicações, de dados, de ciclo de vida ou de verbo de segurança.

Verbo (alias) Ação Sinônimos a serem evitados
Use (u) Usa ou inclui um recurso para fazer algo.

Consulte Também