Common Parameter Names (Nomes de Parâmetros Comuns)

Artigo
09/27/2021

Os parâmetros descritos neste tópico são referidos como parâmetros comuns. São adicionados aos cmdlets pelo tempo de execução Windows PowerShell e não podem ser declarados pelo cmdlet.

Nota

Estes parâmetros são também adicionados aos cmdlets do fornecedor e às funções que são decoradas com o CmdletBinding atributo.

Parâmetros comuns gerais

Os seguintes parâmetros são adicionados a todos os cmdlets e podem ser acedidos sempre que o cmdlet é executado. Estes parâmetros são definidos pela classe System.Management.Automation.Internal.Commonparameters.

Confirmar (pseudónimo: cf)

Tipo de dados: SwitchParameter

Este parâmetro especifica se o cmdlet apresenta uma solicitação que pergunta se o utilizador tem a certeza de que pretende continuar.

Debug (pseudónimo: db)

Tipo de dados: SwitchParameter

Este parâmetro especifica se as mensagens de depuragem ao nível do programador que podem ser exibidas na linha de comando. Estas mensagens destinam-se a resolver problemas ao funcionamento do cmdlet e são geradas por chamadas para o método System.Management.Automation.Cmdlet.WriteDebug. As mensagens de depurg não precisam de ser localizadas.

ErrorAction (pseudónimo: ea)

Tipo de dados: Enumeração

Este parâmetro especifica que ação deve ocorrer quando ocorre um erro. Os valores possíveis para este parâmetro são definidos pela enumeração System.Management.Automation.Actionpreference.

ErroVariável (pseudónimo: ev)

Tipo de dados: String

Este parâmetro especifica a variável para colocar objetos quando ocorre um erro. Para anexar a esta variável, use +varname em vez de limpar e definir a variável.

OutBuffer (pseudónimo: ob)

Tipo de dados: Int32

Este parâmetro define o número de objetos a armazenar no tampão de saída antes de quaisquer objetos serem passados pelo oleoduto. Por predefinição, os objetos são imediatamente passados pelo oleoduto.

OutVariable (pseudónimo: ov)

Tipo de dados: String

Este parâmetro especifica a variável na qual colocar todos os objetos de saída gerados pelo cmdlet. Para anexar a esta variável, use +varname em vez de limpar e definir a variável.

PipelineVariable (pseudónimo: pv)

Tipo de dados: String

Este parâmetro armazena o valor do elemento de gasoduto atual como variável para qualquer comando nomeado à medida que flui através do gasoduto.

Verbose (pseudónimo: vb)

Tipo de dados: SwitchParameter

Este parâmetro especifica se o cmdlet escreve mensagens explicativas que podem ser exibidas na linha de comando. Estas mensagens destinam-se a fornecer ajuda adicional ao utilizador e são geradas por chamadas para o método System.Management.Automation.Cmdlet.WriteVerbose.

AdvertênciaAcção (pseudónimo: wa)

Tipo de dados: Enumeração

Este parâmetro especifica que ação deve ocorrer quando o cmdlet escreve uma mensagem de aviso. Os valores possíveis para este parâmetro são definidos pela enumeração System.Management.Automation.Actionpreference.

AvisoVariável (pseudónimo: wv)

Tipo de dados: String

Este parâmetro especifica a variável na qual as mensagens de aviso podem ser guardadas. Para anexar a esta variável, use +varname em vez de limpar e definir a variável.

Parâmetros Risk-Mitigation

São adicionados os seguintes parâmetros aos cmdlets que solicitam a confirmação antes de realizarem a sua ação. Para obter mais informações sobre pedidos de confirmação, consulte Solicitação de Confirmação. Estes parâmetros são definidos pela classe System.Management.Automation.Internal.Shouldprocessparameters.

WhatIf (pseudónimo: wi)

Tipo de dados: SwitchParameter

Este parâmetro especifica se o cmdlet escreve uma mensagem que descreve os efeitos de executar o cmdlet sem realmente realizar qualquer ação.

Parâmetros de transação

O parâmetro a seguir é adicionado aos cmdlets que suportam as transações. Estes 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.