13. Cmdlets

Nota editorial

Importante

A Especificação de Linguagem do Windows PowerShell 3.0 foi publicada em dezembro de 2012 e é baseada no Windows PowerShell 3.0. Essa especificação não reflete o estado atual do PowerShell. Não há nenhum plano para atualizar essa documentação para refletir o estado atual. Esta documentação é apresentada aqui para referência histórica.

O documento de especificação está disponível como um documento do Microsoft Word do Centro de Download da Microsoft em: https://www.microsoft.com/download/details.aspx?id=36389 esse documento do Word foi convertido para apresentação aqui no Microsoft Learn. Durante a conversão, algumas alterações editoriais foram feitas para acomodar a formatação para a plataforma Docs. Alguns erros de digitação e pequenos foram corrigidos.

Um cmdlet é um comando de recurso único que manipula objetos no PowerShell. Os cmdlets podem ser reconhecidos por seu formato de nome, um verbo e um substantivo separados por um traço (-), como Get-Help, Get-Processe Start-Service. Um padrão de verbo é um verbo expresso com uso de curingas, como em W*. Um padrão de substantivo é um substantivo expresso com uso de curingas, como em evento.

Os cmdlets devem ser simples e criados para serem usados em combinação com outros cmdlets. Por exemplo, os cmdlets Get só devem recuperar dados, os cmdlets Set só devem estabelecer ou alterar dados, os cmdlets Format só devem formatar dados, e os cmdlets Out só devem direcionar a saída para um destino especificado.

Para cada cmdlet, forneça um arquivo de ajuda que pode ser acessado digitando:

Get-Help *cmdlet-name* -Detailed

A exibição detalhada do arquivo de ajuda do cmdlet deve incluir uma descrição do cmdlet, a sintaxe de comando, as descrições dos parâmetros e um exemplo que demonstra o uso desse cmdlet.

Os cmdlets são usados de forma semelhante aos comandos e utilitários do sistema operacional. Os comandos do PowerShell não diferenciam maiúsculas de minúsculas.

Nota

Observação do editor: O documento original contém uma lista de cmdlet com descrições, diagramas de sintaxe, definições de parâmetro e exemplos. Essas informações estão incompletas e desatualizada. Para obter informações atuais sobre cmdlets, consulte a seção Referência da documentação do PowerShell.

13.1 Parâmetros comuns

Os parâmetros comuns são um conjunto de parâmetros de cmdlet que podem ser usados com qualquer cmdlet. Eles são implementados pelo próprio ambiente de runtime do PowerShell, não pelo desenvolvedor do cmdlet e estão automaticamente disponíveis para qualquer cmdlet ou função que use o atributo Parameter (§12.3.7) ou atributo CmdletBinding (§12.3.5).

Embora os parâmetros comuns sejam aceitos por qualquer cmdlet, eles podem não ter nenhuma semântica para esse cmdlet. Por exemplo, se um cmdlet não gerar nenhuma saída detalhada, o uso do parâmetro comum Verbose não terá nenhum efeito.

Vários parâmetros comuns substituem padrões ou preferências do sistema que podem ser definidas por meio de variáveis de preferência (§2.3.2.3). Ao contrário das variáveis de preferência, os parâmetros comuns afetam apenas os comandos nos quais são usados.

Nota

Observação do editor: o documento original contém uma lista dos Parâmetros Comuns. Essas informações estão incompletas e desatualizada. Para obter informações atuais, consulte about_CommonParameters.