Comandos de Verbos Aprovados do PowerShell
PowerShell usa um par verbo-substantivo para os nomes dos cmdlets e para as suas classes derivadas .NET.
A parte verbo do nome identifica a ação que o cmdlet executa. A parte substantiva do nome identifica a entidade em que a ação é realizada. Por exemplo, o Get-Command
cmdlet recupera todos os comandos registados no PowerShell.
Nota
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 na língua inglesa. Por exemplo, o termo Novo é um nome de verbo powerShell válido porque implica uma ação, mesmo que não seja um verbo na língua inglesa.
Cada verbo aprovado tem um prefixo de pseudónimo correspondente definido. Usamos este prefixo de pseudónimos em pseudónimos para comandos usando esse verbo. Por exemplo, o prefixo do pseudónimo para Import
é ip
e, consequentemente, o pseudónimo é Import-Module
ipmo
. Esta é uma recomendação, mas não uma regra; em particular, não precisa de ser respeitado por pseudónimos de comando que imitam comandos bem conhecidos de outros ambientes.
Verbo Nomeação Recomendações
As seguintes recomendações ajudam-no a escolher um verbo apropriado para o seu cmdlet, para garantir a consistência entre os cmdlets que cria, os cmdlets fornecidos pela PowerShell e os cmdlets que são desenhados por outros.
- Utilize um dos nomes de verbos predefinidos fornecidos pela PowerShell
- Utilize o verbo para descrever o âmbito geral da ação e utilize parâmetros para aperfeiçoar ainda mais a ação do cmdlet.
- Não utilize um sinónimo de verbo aprovado. Por exemplo, utilize
Remove
sempre, nunca useDelete
ouEliminate
. . - Utilize apenas a forma de cada verbo listado neste tópico. Por exemplo, utilize
Get
, mas não useGetting
ouGets
. . - Não utilize os seguintes verbos ou pseudónimos reservados. A linguagem PowerShell e alguns cmdlets raros usam estes verbos em circunstâncias excecionais.
- ForEach (foreach)
- Ping (pi)
- Tipo (sr)
- Tee (te)
- Onde (wh)
Pode obter uma lista completa de verbos utilizando o Get-Verb
cmdlet.
Verbos semelhantes para diferentes ações
Os seguintes verbos semelhantes representam diferentes ações.
Novo vs. Adicionar
Use o New
verbo para criar um novo recurso. Utilize o Add
para adicionar algo a um recipiente ou recurso existente. Por exemplo, Add-Content
adiciona saída a um ficheiro existente.
Novo vs. Conjunto
Use o New
verbo para criar um novo recurso. Utilize o Set
verbo para modificar um recurso existente, criando opcionalmente se não existir, como o Set-Variable
cmdlet.
Encontrar vs. Pesquisar
Use o Find
verbo para procurar um objeto. Utilize o Search
verbo para criar uma referência a um recurso num recipiente.
Obter vs. Ler
Utilize o Get
verbo para obter informações sobre um recurso (como um ficheiro) ou para obter um objeto com o qual poderá aceder ao recurso no futuro. Utilize o Read
verbo para abrir um recurso e extrair informações contidas no interior.
Invocar vs. Iniciar
Utilize o Invoke
verbo para realizar operações sincronizadas, tais como executar um comando e esperar que termine. Utilize o Start
verbo para iniciar operações assíncronos, como iniciar um processo autónomo.
Ping vs. Teste
Use o Test
verbo.
Verbos comuns
A PowerShell utiliza a classe de enumeração System.Management.Automation.VerbsCommon para definir ações genéricas que podem aplicar-se a quase todos os cmdlet. A tabela que se segue lista a maioria dos verbos definidos.
Verbo (pseudónimo) | Ação | Sinónimos para evitar |
---|---|---|
Adicionar (a) | Adiciona um recurso a um recipiente ou anexa um item a outro item. Por exemplo, o Add-Content cmdlet adiciona conteúdo a um ficheiro. Este verbo é emparelhado com Remove . |
Apêndice, Anexação, Concatenate, Inserção |
Claro (cl) | Retira todos os recursos de um recipiente, mas não apaga o recipiente. Por exemplo, o Clear-Content cmdlet remove o conteúdo de um ficheiro, mas não apaga o ficheiro. |
Flush, Apagar, Soltar, Unmark, Unset, Nullify |
Fechar (cs) | Altera o estado de um recurso para torná-lo inacessível, indisponível ou inutilizável. Este verbo é emparelhado com Open. |
|
Cópia (cp) | Copia um recurso para outro nome ou para outro recipiente. Por exemplo, o Copy-Item cmdlet copia um item (como um ficheiro) de um local na loja de dados para outro local. |
Duplicado, Clone, Replica, Sync |
Insira (et) | Especifica uma ação que permite ao utilizador mover-se para um recurso. Por exemplo, o Enter-PSSession cmdlet coloca o utilizador numa sessão interativa. Este verbo é emparelhado com Exit . |
Push, Para |
Saída (ex) | Define o ambiente ou contexto atual ao contexto mais recentemente utilizado. Por exemplo, o Exit-PSSession cmdlet coloca o utilizador na sessão que foi usada para iniciar a sessão interativa. Este verbo é emparelhado com Enter . |
Pop, out |
Encontrar (fd) | Procura um objeto num recipiente desconhecido, implícito, opcional ou especificado. | Pesquisar |
Formato (f) | Organiza objetos de uma forma ou layout especificado | |
Obter (g) | Especifica uma ação que recupera um recurso. Este verbo é emparelhado com Set . |
Ler, Abrir, Gato, Tipo, Dir, Obter, Despejar, Adquirir, Examinar, Encontrar, Pesquisar |
Esconder (h) | Torna um recurso indetetável. Por exemplo, um cmdlet cujo nome inclui o verbo Hide pode ocultar um serviço de um utilizador. Este verbo é emparelhado com Show . |
Bloquear |
Junte-se (j) | Combina recursos num único recurso. Por exemplo, o Join-Path cmdlet combina um caminho com um dos seus caminhos infantis para criar um único caminho. Este verbo é emparelhado com Split . |
Combine, Unir, Ligação, Associado |
Bloqueio (lk) | Protege um recurso. Este verbo é emparelhado com Unlock . |
Restringir, Proteger |
Mover ( m) | Move um recurso de um local para outro. Por exemplo, o Move-Item cmdlet desloca um item de um local na loja de dados para outro local. |
Transferência, Nome, Migração |
Novo (n) | Cria um recurso. (O Set verbo também pode ser usado ao criar um recurso que inclua dados, como o Set-Variable cmdlet.) |
Criar, Gerar, Construir, Fazer, Alocar |
Aberto (op) | Altera o estado de um recurso para torná-lo acessível, disponível ou utilizável. Este verbo é emparelhado com Close . |
|
Otimizar (om) | Aumenta a eficácia de um recurso. | |
Pop (pop) | Remove um item do topo de uma pilha. Por exemplo, o Pop-Location cmdlet altera a localização atual para o local que foi mais recentemente empurrado para a pilha. |
|
Empurrar (pu) | Adiciona um item ao topo de uma pilha. Por exemplo, o Push-Location cmdlet empurra a localização atual para a pilha. |
|
Redo (re) | Repõe um recurso para o estado que foi desfeito. | |
Remover (r) | Elimina um recurso de um recipiente. Por exemplo, o Remove-Variable cmdlet elimina uma variável e o seu valor. Este verbo é emparelhado com Add . |
Limpar, cortar, eliminar, descartar, apagar |
Renome ( rn) | Altera o nome de um recurso. Por exemplo, o Rename-Item cmdlet, que é utilizado para aceder a dados armazenados, altera o nome de um item na loja de dados. |
Alterar |
Reset (rs) | Define um recurso de volta ao seu estado original. | |
Redimensionar(rz) | Altera o tamanho de um recurso. | |
Pesquisa (sr) | Cria uma referência a um recurso num recipiente. | Localizar, Localizar |
Selecione (sc) | Localiza um recurso num contentor. Por exemplo, o Select-String cmdlet encontra texto em cordas e ficheiros. |
Localizar, Localizar |
Conjunto (s) | Substitui dados num recurso existente ou cria um recurso que contém alguns dados. Por exemplo, o Set-Date cmdlet altera o tempo do sistema no computador local. (O New verbo também pode ser usado para criar um recurso.) Este verbo é emparelhado com Get . |
Escrever, Redefinir, Atribuir, Configurar |
Show (sh) | Torna um recurso visível para o utilizador. Este verbo é emparelhado com Hide . |
Exibição, Produzir |
Skip (sk) | Contorna um ou mais recursos ou pontos numa sequência. | Bypass, Jump |
Dividido (sl) | Separa partes de um recurso. Por exemplo, o Split-Path cmdlet devolve diferentes partes de um caminho. Este verbo é emparelhado com Join . |
Separados |
Passo (st) | Move-se para o próximo ponto ou recurso numa sequência. | |
Interruptor (sw) | Especifica uma ação que alterna entre dois recursos, tais como a mudança entre dois locais, responsabilidades ou estados. | |
Desfazer (un) | Define um recurso para o seu estado anterior. | |
Desbloqueie (reino unido) | Liberta um recurso que estava bloqueado. Este verbo é emparelhado com Lock . |
Lançamento, Sem restrições, Unsecure |
Relógio (wc) | Inspeciona ou monitoriza continuamente um recurso para alterações. |
Verbos de Comunicações
A PowerShell utiliza a classe System.Management.Automation.VerbsCommunications para definir ações que se aplicam às comunicações. A tabela que se segue lista a maioria dos verbos definidos.
Verbo (pseudónimo) | Ação | Sinónimos para evitar |
---|---|---|
Ligação (cc) | Cria uma ligação entre uma fonte e um destino. Este verbo é emparelhado com Disconnect . |
Junte-se a Telnet |
Desconexão (dc) | Quebra a ligação entre uma fonte e um destino. Este verbo é emparelhado com Connect . |
Break |
Ler (rd) | Adquire informação de uma fonte. Este verbo é emparelhado com Write . |
Adquirir, Prompt, Obter |
Receber (rc) | Aceita informações enviadas de uma fonte. Este verbo é emparelhado com Send . |
Ler, Aceitar, Espreitar |
Enviar (sd) | Entrega informações para um destino. Este verbo é emparelhado com Receive . |
Put, Broadcast, Mail, Fax |
Escrever (wr) | Adiciona informação a um alvo. Este verbo é emparelhado com Read . |
Colocar, Imprimir |
Verbos de dados
A PowerShell utiliza a classe System.Management.Automation.VerbsData para definir ações que se aplicam ao tratamento de dados. A tabela que se segue lista a maioria dos verbos definidos.
Nome verbo (pseudónimo) | Ação | Sinónimos para evitar |
---|---|---|
Backup (ba) | Armazena dados replicando-os. | Salvar, Queimar, Replicar, Sincronizar |
Posto de controlo (ch) | Cria uma imagem instantânea do estado atual dos dados ou da sua configuração. | Desvio |
Comparar (cr) | Avalia os dados de um recurso contra os dados de outro recurso. | Desvio |
Compress (cm) | Compacta os dados de um recurso. Pares com Expand . |
Compactar |
Converter (cv) | Altera os dados de uma representação para outra quando o cmdlet suporta a conversão bidirecional ou quando o cmdlet suporta a conversão entre vários tipos de dados. | Change, Resize, Resample |
Converted ( cf) | Converte um tipo primário de entrada (o substantivo cmdeto indica a entrada) para um ou mais tipos de saída suportados. | Exportação, Produção, Fora |
ConvertTo (ct) | Converte de um ou mais tipos de entrada para um tipo de saída primária (o substantivo cmdlet indica o tipo de saída). | Importação, Entrada, |
Desmontagem (dm) | Desprende uma entidade nomeada de um local. Este verbo é emparelhado com Mount . |
Desmonte, Unlink |
Editar (ed) | Modifica os dados existentes adicionando ou removendo conteúdo. | Alterar, Atualizar, Modificar |
Expandir (en) | Restaura os dados de um recurso que foi comprimido ao seu estado original. Este verbo é emparelhado com Compress . |
Explodir, Descomprimir |
Exportação (ep) | Encapsula a entrada primária numa loja de dados persistente, como um ficheiro, ou num formato de intercâmbio. Este verbo é emparelhado com Import . |
Extrato, Backup |
Grupo (gp) | Organiza ou associa um ou mais recursos | |
Importação (ip) | Cria um recurso a partir de dados que são armazenados numa loja de dados persistente (como um ficheiro) ou num formato de intercâmbio. Por exemplo, o Import-CSV cmdlet importa dados de um ficheiro de valor separado de vírgula (CSV) para objetos que podem ser utilizados por outros cmdlets. Este verbo é emparelhado com Export . |
Carga a granel, carga |
Inicializar (in) | Prepara um recurso para utilização e define-o para um estado predefinido. | Apagar, Init, Renovar, Reconstruir, Reinitializar, Configurar |
Limite (l) | Aplica restrições a um recurso. | Quota |
Fusão (mg) | Cria um único recurso a partir de múltiplos recursos. | Combine, Junte-se |
Monte (mt) | Anexa uma entidade nomeada a um local. Este verbo é emparelhado com Dismount . |
Ligar |
Fora (o) | Envia dados para fora do ambiente. Por exemplo, o Out-Printer cmdlet envia dados para uma impressora. |
|
Publicar (pb) | Disponibiliza um recurso aos outros. Este verbo é emparelhado com Unpublish . |
Implementar, soltar, instalar |
Restauro (rr) | Define um recurso para um estado predefinido, como um estado definido por Checkpoint . Por exemplo, o Restore-Computer cmdlet inicia uma restauração do sistema no computador local. |
Reparação, Devolução, Desfazer, Correção |
Salvar (sv) | Preserva dados para evitar perdas. | |
Sincronização (sy) | Assegura que dois ou mais recursos estão no mesmo estado. | Replicar, Coagir, Combinar |
Não publicado (ub) | Torna um recurso indisponível para os outros. Este verbo é emparelhado com Publish . |
Desinstalar, Reverter, Esconder |
Atualização (ud) | Traz um recurso atualizado para manter o seu estado, precisão, conformidade ou conformidade. Por exemplo, o Update-FormatData cmdlet atualiza e adiciona ficheiros de formatação à atual consola PowerShell. |
Atualizar, Renovar, Recalcular, Re-indexar |
Verbos de Diagnóstico
A PowerShell utiliza a classe System.Management.Automation.VerbsDiagnostic para definir ações que se aplicam aos diagnósticos. A tabela que se segue lista a maioria dos verbos definidos.
Verbo (pseudónimo) | Ação | Sinónimos para evitar |
---|---|---|
Debug (db) | Examina um recurso para diagnosticar problemas operacionais. | Diagnóstico |
Medida (ms) | Identifica recursos que são consumidos por uma operação especificada, ou recupera estatísticas sobre um recurso. | Calcular, Determinar, Analisar |
Ping (pi) | Precado - Use o verbo de teste em vez disso. | |
Reparação (rp) | Restaura um recurso a uma condição utilizável | Fix, Restaurar |
Resolver (rv) | Mapas uma representação abreviada de um recurso para uma representação mais completa. | Expandir, Determinar |
Teste (t) | Verifica a operação ou consistência de um recurso. | Diagnosticar, Analisar, Salvar, Verificar |
Vestígios (tr) | Acompanha as atividades de um recurso. | Faixa, Seguir, Inspecionar, Cavar |
Verbos do ciclo de vida
A PowerShell utiliza a classe System.Management.Automation.VerbsLifeCycle para definir ações que se aplicam ao ciclo de vida de um recurso. A tabela que se segue lista a maioria dos verbos definidos.
Verbo (pseudónimo) | Ação | Sinónimos para evitar |
---|---|---|
Aprovar (ap) | Confirma ou concorda com o estado de um recurso ou processo. | |
Afirmação (como) | Afirma o estado de um recurso. | Certify |
Construção (bd) | Cria um artefacto (geralmente binário ou documento) a partir de algum conjunto de ficheiros de entrada (geralmente código fonte ou documentos declarativos.) Este verbo foi adicionado no PowerShell 6. | |
Completo (cp) | Conclui uma operação. | |
Confirmar (cn) | Reconhece, verifica ou valida o estado de um recurso ou processo. | Reconhecer, Concordar, Certificar, Validar, Verificar |
Negar (dn) | Recusa,objetos, bloqueia ou opõe-se ao estado de um recurso ou processo. | Bloco, Objeto, Recusar, Rejeitar |
Implantação (dp) | Envia uma aplicação, website ou solução para um alvo remoto de forma a que um consumidor dessa solução possa aceder à sua utilização após a implementação estar concluída. Este verbo foi adicionado no PowerShell 6. | |
Desativação (d) | Configura um recurso para um estado indisponível ou inativo. Por exemplo, o Disable-PSBreakpoint cmdlet torna um ponto de rutura inativo. Este verbo é emparelhado com Enable . |
Pare, esconda-se |
Ativar (e) | Configura um recurso para um estado disponível ou ativo. Por exemplo, o Enable-PSBreakpoint cmdlet torna um ponto de rutura ativo. Este verbo é emparelhado com Disable . |
Começar, Começar |
Instalação (is) | Coloca um recurso num local e ini opcionalmente inicializa-o. Este verbo é emparelhado com Uninstall . |
Configuração |
Invocar (i) | Executa uma ação, como executar um comando ou um método. | Run, Start |
Registo (rg) | Cria uma entrada para um recurso num repositório como uma base de dados. Este verbo é emparelhado com Unregister . |
|
Pedido (rq) | Pede um recurso ou pede permissões. | |
Reiniciar (rt) | Para uma operação e depois recomeça. Por exemplo, o Restart-Service cmdlet para e inicia um serviço. |
Reciclar |
Currículo (ru) | Inicia uma operação que foi suspensa. Por exemplo, o Resume-Service cmdlet inicia um serviço que foi suspenso. Este verbo é emparelhado com Suspend . |
|
Início (sa) | Inicia uma operação. Por exemplo, o Start-Service cmdlet inicia um serviço. Este verbo é emparelhado com Stop . |
Lançamento, Iniciar, Arranque |
Paragem (sp) | Descontinua uma atividade. Este verbo é emparelhado com Start . |
Fim, Morte, Fim, Cancelamento, Cancelamento |
Submeter (sb) | Apresenta um recurso para aprovação. | Publicar |
Suspender (ss) | Pausa uma atividade. Por exemplo, o Suspend-Service cmdlet faz uma pausa num serviço. Este verbo é emparelhado com Resume . |
Colocar em pausa |
Desinstalar (nós) | Remove um recurso de um local indicado. Este verbo é emparelhado com Install . |
|
Não registro (o seu) | Remove a entrada de um recurso de um repositório. Este verbo é emparelhado com Register . |
Remover |
Espera (w) | Pausa uma operação até ocorrer um evento especificado. Por exemplo, o Wait-Job cmdlet interrompe as operações até que um ou mais dos trabalhos de fundo estejam completos. |
Sono, Pausa |
Verbos de Segurança
A PowerShell utiliza a classe System.Management.Automation.VerbsSecurity para definir ações que se aplicam à segurança. A tabela que se segue lista a maioria dos verbos definidos.
Verbo (pseudónimo) | Ação | Sinónimos para evitar |
---|---|---|
Bloco (bl) | Restringe o acesso a um recurso. Este verbo é emparelhado com Unblock . |
Prevenir, Limitar, Negar |
Subvenção (gr) | Permite o acesso a um recurso. Este verbo é emparelhado com Revoke . |
Permitir, Ativar |
Proteger (pt) | Salvaguarda um recurso de ataque ou perda. Este verbo é emparelhado com Unprotect . |
Encriptar, Salvaguardar, Selar |
Revogar (rk) | Especifica uma ação que não permite o acesso a um recurso. Este verbo é emparelhado com Grant . |
Remover, Desativar |
Desbloqueio (ul) | Remove restrições a um recurso. Este verbo é emparelhado com Block . |
Claro, permitir |
Desprotegido (para cima) | Remove as salvaguardas de um recurso que foi adicionado para evitar que ataque ou perda. Este verbo é emparelhado com Protect . |
Desencript, Unseal |
Outros Verbos
A PowerShell utiliza a classe System.Management.Automation.VerbsOther para definir nomes de verbos canónicos que não se enquadram numa categoria específica de nomes verbos, tais como os verbos comuns, comunicações, dados, ciclo de vida ou verbos de segurança.
Verbo (pseudónimo) | Ação | Sinónimos para evitar |
---|---|---|
Utilização (u) | Usa ou inclui um recurso para fazer algo. |
Consulte também
- System.Management.Automation.VerbsCommon
- System.Management.Automation.VerbsCommunications
- System.Management.Automation.VerbsData
- Sistema.Management.Automation.VerbsDiagnostic
- System.Management.Automation.VerbsLifeCycle
- System.Management.Automation.VerbsSecurity
- System.Management.Automation.VerbsOther
- Declaração do Cmdlet
- Windows PowerShell Programmer's Guide (Guia do Programador do Windows PowerShell)
- Windows PowerShell Shell SDK
Comentários
https://aka.ms/ContentUserFeedback.
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja:Submeter e ver comentários