Compartilhar via

Verbos aprovados para comandos do PowerShell

O PowerShell usa um par verbo-substantivo para os nomes de cmdlets e para suas classes .NET derivadas. A parte verbo do nome identifica a ação executada pelo cmdlet. A parte substantiva do nome identifica a entidade na qual a ação é executada. Por exemplo, o cmdlet Get-Command recupera todos os comandos registrados no PowerShell.

Observação

O PowerShell usa o verbo de termo 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, mesmo que 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 de alias para Import é ip e, portanto, o alias para Import-Module é ipmo. Essa é uma recomendação, mas não uma regra; em particular, ele não precisa ser respeitado por aliases de comando que imitam comandos conhecidos de outros ambientes.

Recomendações de nomenclatura de verbo

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

  • Usar um dos nomes de verbo predefinidos fornecidos pelo PowerShell
  • Use o verbo para descrever o escopo geral da ação e use 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 ou Eliminate.
  • Use apenas a forma de cada verbo listado neste tópico. Por exemplo, use Get, mas não use Getting ou Gets.
  • Não use os seguintes verbos ou aliases reservados. A linguagem do PowerShell e alguns cmdlets raros 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.

New Vs. Add

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

New Vs. Set

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

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 Vs. Read

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 verbo Read para abrir um recurso e extrair informações contidas.

Invoke Vs. Start

Use o verbo Invoke para executar operações síncronas, como executar um comando e esperar que ele termine. Use o verbo Start para iniciar operações assíncronas, como iniciar um processo autônomo.

Ping Vs. Test

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 conteúdo a um arquivo. Este verbo é emparelhado com Remove. Acrescentar, Anexar, Concatenar, Inserir
Clear (cl) Remove todos os recursos de um contêiner, mas não exclui o contêiner. Por exemplo, o Clear-Content cmdlet remove o conteúdo de um arquivo, mas não exclui o arquivo. Liberação, apagamento, versão, dinamarca, 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. Duplicar, Clonar, Replicar, Sincronizar
Enter (et) Especifica uma ação que permite que o usuário se mova para um recurso. Por exemplo, o cmdlet Enter-PSSession coloca o usuário em uma sessão interativa. Este verbo é emparelhado com Exit. Efetuar push, para dentro
Exit (ex) Define o ambiente ou contexto atual para o contexto usado mais recentemente. Por exemplo, o cmdlet Exit-PSSession coloca o usuário na sessão usada para iniciar a sessão interativa. Este verbo é emparelhado com Enter. Pop, Fora
Find (fd) Procura um objeto em um contêiner desconhecido, implícito, opcional ou especificado. Buscar
Format (f) Organiza objetos em um formato ou layout especificado
Get (g) Especifica uma ação que recupera um recurso. Este verbo é emparelhado com Set. Ler, Abrir, Gato, Tipo, Dir, Obter, Despejar, Adquirir, Examinar, Localizar, Pesquisar
Hide (h) Torna um recurso indetectável. Por exemplo, um cmdlet cujo nome inclui o verbo Ocultar pode ocultar um serviço de um usuário. Este verbo é emparelhado com Show. Bloco
Join (j) Combina recursos em um recurso. Por exemplo, o cmdlet Join-Path combina um caminho com um de seus caminhos filho para criar um único caminho. Este verbo é emparelhado com Split. Combinar, Unir, Conectar, Associar
Lock (lk) Protege um recurso. Este verbo é emparelhado com Unlock. Restrinja, proteja
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. Transferir, Nomear, Migrar
New (n) Cria um recurso. (O verbo Set também pode ser usado ao criar um recurso que inclua dados, como o cmdlet Set-Variable.) Criar, gerar, compilar, fazer, alocar
Open (op) Altera o estado de um recurso para torná-lo acessível, disponível ou utilizável. Este verbo é emparelhado com Close.
Optimize (om) Aumenta a eficácia de um recurso.
Pop (pop) Remove um item da parte superior de uma pilha. Por exemplo, o cmdlet Pop-Location altera o local atual para o local que foi enviado recentemente para a pilha.
Push (pu) Adiciona um item à parte superior de uma pilha. Por exemplo, o cmdlet Push-Location envia o local atual para a pilha.
Redo (re) Redefine um recurso para o estado que foi desfeito.
Remove (r) Exclui um recurso de um contêiner. Por exemplo, o cmdlet Remove-Variable exclui uma variável e seu valor. Este verbo é emparelhado com Add. Limpar, Recortar, Descartar, Descartar, Apagar
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. Mudar
Reset (rs) Define um recurso de volta para seu estado original.
Resize (rz) Altera o tamanho de um recurso.
Search (sr) Cria uma referência a um recurso em um contêiner. Localizar, Localizar
Select (sc) Localiza um recurso em um contêiner. Por exemplo, o cmdlet Select-String localiza texto em cadeias de caracteres e arquivos. Localizar, Localizar
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.) Este verbo é emparelhado com Get. Gravar, redefinir, atribuir, configurar, atualizar
Show (sh) Torna um recurso visível para o usuário. Este verbo é emparelhado com Hide. Exibir, Produzir
Skip (sk) Ignora um ou mais recursos ou pontos em uma sequência. Desviar, Saltar
Split (sl) Separa partes de um recurso. Por exemplo, o cmdlet Split-Path retorna diferentes partes de um caminho. Este verbo é emparelhado com Join. Separar
Step (st) Move 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 seu estado anterior.
Unlock (uk) Libera um recurso que foi bloqueado. Este verbo é emparelhado com Lock. Versão, 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 ações que se aplicam às 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 link entre uma origem e um destino. Este verbo é emparelhado com Disconnect. Ingressar, Telnet, Logon
Disconnect (dc) Interrompe o vínculo entre uma origem e um destino. Este verbo é emparelhado com Connect. Quebra, Logoff
Read (rd) Adquire informações de uma fonte. Este verbo é emparelhado com Write. Adquirir, Solicitar, Obter
Receive (rc) Aceita informações enviadas de uma fonte. Este verbo é emparelhado com Send. Ler, aceitar, espiar
Send (sd) Fornece informações para um destino. Este verbo é emparelhado com Receive. Colocar, Transmitir, Correio, Fax
Write (wr) Adiciona informações a um destino. Este verbo é emparelhado com Read. Colocar, imprimir

Verbos de dados

O PowerShell usa a classe System.Management.Automation.VerbsData para definir ações que se aplicam ao tratamento 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. Salvar, Gravar, Replicar, Sincronizar
Checkpoint (ch) Cria um instantâneo do estado atual dos dados ou de sua configuração. 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. Pares 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. Alterar, Redimensionar, Resamplar
ConvertFrom (cf) Converte um tipo primário de entrada (o substantivo de cmdlet indica a entrada) em um ou mais tipos de saída com suporte. Exportar, Saída, Sair
ConvertTo (ct) Converte de um ou mais tipos de entrada em um tipo de saída primário (o substantivo cmdlet indica o tipo de saída). Importação, entrada, entrada
Dismount (dm) Desanexa uma entidade nomeada de um local. Este verbo é emparelhado com Mount. Desmontar, Desvincular
Edit (ed) Modifica os dados existentes adicionando ou removendo conteúdo. Alterar, atualizar, modificar
Expand (en) Restaura os dados de um recurso que foi compactado para seu estado original. Este verbo é emparelhado com Compress. Explodir, Descompactar
Export (ep) Encapsula a entrada primária em um armazenamento de dados persistente, como um arquivo ou em um formato de intercâmbio. Este verbo é emparelhado com Import. Extração, Backup
Group (gp) Organiza ou associa um ou mais recursos
Import (ip) Cria um recurso com base em dados armazenados em um armazenamento de dados persistente (como um arquivo) ou em um formato de intercâmbio. Por exemplo, o Import-Csv cmdlet importa dados de um arquivo de valor separado por vírgulas (CSV) para objetos que podem ser usados por outros cmdlets. Este verbo é emparelhado com Export. Carga a granel, Carga
Initialize (in) Prepara um recurso para uso e o define como um estado padrão. Apagar, Init, Renovar, Recompilar, Reinicializar, Configurar
Limit (l) Aplica restrições a um recurso. Cota
Merge (mg) Cria um único recurso com base em vários recursos. Combinar, Ingressar
Mount (mt) Anexa uma entidade nomeada a um local. Este 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. Este verbo é emparelhado com Unpublish. Implantar, liberar, instalar
Restore (rr) Define um recurso como um estado predefinido, como um estado definido por Checkpoint. Por exemplo, o cmdlet Restore-Computer inicia uma restauração do sistema no computador local. Reparar, Retornar, Desfazer, Corrigir
Save (sv) Preserva dados para evitar perda.
Sync (sy) Garante que dois ou mais recursos estejam no mesmo estado. Replicar, Coagir, Corresponder
Unpublish (ub) Torna um recurso indisponível para outras pessoas. Este verbo é emparelhado com Publish. Desinstalar, Reverter, Ocultar
Update (ud) Traz um recurso up-todata para manter seu estado, precisão, conformidade ou conformidade. Por exemplo, o cmdlet Update-FormatData atualiza e adiciona arquivos de formatação ao console atual do PowerShell. Atualizar, renovar, recalcular, indexar novamente

Verbos de Diagnóstico

O PowerShell usa a classe System.Management.Automation.VerbsDiagnostic para definir 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 consumidos por uma operação especificada ou recupera estatísticas sobre um recurso. Calcular, determinar, analisar
Ping (pi) Preterido – use o verbo De teste.
Repair (rp) Restaura um recurso para uma condição utilizável Correção, restauração
Resolve (rv) Mapeia uma representação abreviada de um recurso para uma representação mais completa. Expandir, Determinar
Test (t) Verifica a operação ou a consistência de um recurso. Diagnosticar, analisar, salvar, verificar
Trace (tr) Controla as atividades de um recurso. Acompanhar, seguir, inspecionar, cavar

Verbos do ciclo de vida

O PowerShell usa a classe System.Management.Automation.VerbsLifecycle para definir 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 ou concorda com o status de um recurso ou processo.
Assert (as) Afirma o estado de um recurso. Certificar
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).) Este verbo foi adicionado ao PowerShell 6.
Complete (cp) Conclui uma operação.
Confirm (cn) Reconhece, verifica ou valida o estado de um recurso ou processo. Reconhecer, concordar, certificar, validar, verificar
Deny (dn) Recusa, objetos, blocos ou se opõe ao estado de um recurso ou processo. Bloquear, Objeto, Recusar, Rejeitar
Deploy (dp) Envia um aplicativo, site ou solução para um destino remoto de forma que um consumidor dessa solução possa acessá-lo após a conclusão da implantação. Este verbo foi adicionado ao 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. Este verbo é emparelhado com Enable. Parar, Ocultar
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. Este verbo é emparelhado com Disable. Iniciar, Começar
Install (is) Coloca um recurso em um local e, opcionalmente, inicializa-o. Este verbo é emparelhado com Uninstall. Configuração
Invoke (i) Executa uma ação, como executar um comando ou um método. Executar, Iniciar
Register (rg) Cria uma entrada para um recurso em um repositório, como um banco de dados. Este verbo é emparelhado com Unregister.
Request (rq) Solicita um recurso ou solicita permissões.
Restart (rt) Interrompe uma operação e, em seguida, inicia-a 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. Este verbo é emparelhado com Suspend.
Start (sa) Inicia uma operação. Por exemplo, o cmdlet Start-Service inicia um serviço. Este verbo é emparelhado com Stop. Iniciar, Iniciar, Inicializar
Stop (sp) Descontinua uma atividade. Este verbo é emparelhado com Start. Encerrar, Encerrar, Cancelar
Submit (sb) Apresenta um recurso para aprovação. Postar
Suspend (ss) Pausa uma atividade. Por exemplo, o cmdlet Suspend-Service pausa um serviço. Este verbo é emparelhado com Resume. Pausa
Uninstall (us) Remove um recurso de um local indicado. Este verbo é emparelhado com Install.
Unregister (ur) Remove a entrada de um recurso de um repositório. Este verbo é emparelhado com Register. Retirar
Wait (w) Pausa uma operação até que ocorra um evento especificado. Por exemplo, o cmdlet Wait-Job pausa as operações até que um ou mais dos trabalhos em segundo plano sejam concluídos. Dormir, Pausar

Verbos de segurança

O PowerShell usa a classe System.Management.Automation.VerbsSecurity para definir 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. Este verbo é emparelhado com Unblock. Prevenir, limitar, negar
Grant (gr) Permite o acesso a um recurso. Este verbo é emparelhado com Revoke. Permitir, Habilitar
Protect (pt) Protege um recurso contra ataque ou perda. Este verbo é emparelhado com Unprotect. Criptografar, proteger, lacrar
Revoke (rk) Especifica uma ação que não permite o acesso a um recurso. Este verbo é emparelhado com Grant. Remover, Desabilitar
Unblock (ul) Remove restrições a um recurso. Este verbo é emparelhado com Block. Limpar, Permitir
Unprotect (up) Remove as proteções de um recurso que foram adicionados para evitar que ele ataque ou perda. Este verbo é emparelhado com Protect. Descriptografar, Descriptografar

Outros verbos

O PowerShell usa a classe System.Management.Automation.VerbsOther para definir nomes de verbo canônicos que não se encaixam em uma categoria de nome de verbo específico, como os verbos comuns, comunicações, dados, ciclo de vida ou verbos de verbos 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