Nomes de parâmetro comuns
Os parâmetros descritos neste tópico são chamados de parâmetros comuns. Eles são adicionados aos cmdlets pelo runtime Windows PowerShell e não podem ser declarados pelo cmdlet .
Observação
Esses parâmetros também são adicionados aos cmdlets do provedor e às funções decoradas com o CmdletBinding atributo .
Parâmetros comuns gerais
Os parâmetros a seguir são adicionados a todos os cmdlets e podem ser acessados sempre que o cmdlet é executado. Esses parâmetros são definidos pela classe System.Management.Automation.Internal.Commonparameters.
Confirmar (alias: cf)
Tipo de dados: SwitchParameter
Esse parâmetro especifica se o cmdlet exibe um prompt que pergunta se o usuário tem certeza de que deseja continuar.
Depurar (alias: db)
Tipo de dados: SwitchParameter
Esse parâmetro especifica se as mensagens de depuração no nível do programador podem ser exibidas na linha de comando. Essas mensagens destinam-se a solucionar problemas da operação do cmdlet e são geradas por chamadas para o método System.Management.Automation.Cmdlet.WriteDebug. As mensagens de depuração não precisam ser localizadas.
ErrorAction (alias: ea)
Tipo de dados: Enumeração
Esse parâmetro especifica qual ação deve ocorrer quando ocorre um erro. Os valores possíveis para esse parâmetro são definidos pela enumeração System.Management.Automation.Actionpreference.
ErrorVariable (alias: ev)
Tipo de dados: cadeia de caracteres
Esse parâmetro especifica a variável na qual colocar objetos quando ocorrer um erro. Para anexar a essa variável, use +varname em vez de limpar e definir a variável.
OutBuffer (alias: ob)
Tipo de dados: Int32
Esse parâmetro define o número de objetos a armazenar no buffer de saída antes que qualquer objeto seja passado pelo pipeline. Por padrão, os objetos são passados imediatamente para baixo do pipeline.
OutVariable (alias: ov)
Tipo de dados: cadeia de caracteres
Esse parâmetro especifica a variável na qual colocar todos os objetos de saída gerados pelo cmdlet . Para anexar a essa variável, use +varname em vez de limpar e definir a variável.
PipelineVariable (alias: pv)
Tipo de dados: cadeia de caracteres
Esse parâmetro armazena o valor do elemento de pipeline atual como uma variável para qualquer comando nomeado à medida que ele flui pelo pipeline.
Detalhado (alias: vb)
Tipo de dados: SwitchParameter
Esse parâmetro especifica se o cmdlet grava mensagens explicativas que podem ser exibidas na linha de comando. Essas mensagens destinam-se a fornecer ajuda adicional ao usuário e são geradas por chamadas para o método System.Management.Automation.Cmdlet.WriteVerbose.
WarningAction (alias: wa)
Tipo de dados: Enumeração
Esse parâmetro especifica qual ação deve ocorrer quando o cmdlet grava uma mensagem de aviso. Os valores possíveis para esse parâmetro são definidos pela enumeração System.Management.Automation.Actionpreference.
WarningVariable (alias: wv)
Tipo de dados: cadeia de caracteres
Esse parâmetro especifica a variável na qual as mensagens de aviso podem ser salvas. Para anexar a essa variável, use +varname em vez de limpar e definir a variável.
Risk-Mitigation parâmetros
Os parâmetros a seguir são adicionados aos cmdlets que solicitam confirmação antes de executarem sua ação. Para obter mais informações sobre solicitações de confirmação, consulte Solicitando confirmação. Esses parâmetros são definidos pela classe System.Management.Automation.Internal.Shouldprocessparameters.
WhatIf (alias: wi)
Tipo de dados: SwitchParameter
Esse parâmetro especifica se o cmdlet grava uma mensagem que descreve os efeitos da execução do cmdlet sem realmente executar nenhuma ação.
Parâmetros de transação
O parâmetro a seguir é adicionado aos cmdlets que suportam transações. Esses parâmetros são definidos pela classe System.Management.Automation.Internal.Transactionparameters. O suporte à transação foi introduzido no PowerShell 3.0 e descontinuado no PowerShell 6.0.
UseTransaction (alias: usetx)
Tipo de dados: SwitchParameter
Esse parâmetro especifica se o cmdlet usará a transação atual para executar sua ação.
Consulte Também
System.Management.Automation.Internal.Commonparameters
System.Management.Automation.Internal.Shouldprocessparameters
System.Management.Automation.Internal.Transactionparameters
Writing a Windows PowerShell Cmdlet (Escrevendo um Cmdlet do Windows PowerShell)