Parâmetros

Um parâmetro posicional permite especificar o valor do parâmetro sem especificar o nome do parâmetro. Um parâmetro é posicional se o atributo Parameter Position for um inteiro. Esse inteiro indica a posição na linha de comando em que o cmdlet encontrará o valor do parâmetro. Para mais informações sobre os vários atributos que constituem um parâmetro, consulte a seção Detalhes dos parâmetros, adiante neste tópico.

A maioria dos cmdlets tem somente um parâmetro posicional, Identity. Identity está sempre na posição 1 se estiver disponível no cmdlet. Alguns cmdlets têm vários parâmetros posicionais. Com esses cmdlets, você pode especificar os valores para cada parâmetro posicional na ordem especificada pelo atributo Parameter Position em cada parâmetro. Os valores de cada parâmetro devem estar na posição correta da linha de comando, para funcionarem corretamente.

Se um parâmetro não for posicional, será considerado um parâmetro named. Você deve especificar o nome e o valor de um parâmetro para os parâmetros named.

Estes dois comandos executam a mesma tarefa de retornar informações de configuração para um conector de recebimento chamado "Contoso".

Get-ReceiveConnector -Identity "Contoso"
Get-ReceiveConnector "Contoso"

Os dois comandos a seguir executam a mesma tarefa. Os valores do parâmetro posicional no primeiro comando são colocados na ordem exata solicitada pelo atributo Parameter Position em cada parâmetro.

Set-ExampleCmdlet "Seattle Users" $True "Contoso.com"
Set-ExampleCmdlet -Name "Seattle Users" -Enabled $True -Domain "Contoso.com"

Os Atributos, também chamados de metadados, em cada parâmetro estão na seção PARÂMETROS na Ajuda do Shell que é recuperada pelo cmdlet Get-Help. O exemplo a seguir é do cmdlet Get-Service.

PARAMETERS
    -ServiceName System.String[]

        Parameter required?           false
        Parameter position?           1
        Default value                 *
        Accept pipeline input?       true
        Accept wildcard characters?  True

Este exemplo do cmdlet Get-Service inclui alguns detalhes específicos sobre os tipos de valor que podem ser transmitidos para o parâmetro ServiceName. Nem todos os cmdlets possuem esses detalhes. Contudo, a maioria dos cmdlets realmente inclui algumas configurações de cada parâmetro, como descrito na tabela a seguir.

Configurações de parâmetro

Os Parâmetros booleanos são usados no Shell para determinar, entre outras coisas, se um recurso ou opção está habilitado, $True, ou desabilitado, $False. O valor atribuído a um parâmetro booleano é armazenado na configuração do objeto que está sendo modificado. Ao fornecer um valor para um parâmetro booleano, use os valores $True ou 1, ou $False ou 0. O símbolo de cifrão ($) deve constar em $True e em $False. Observe que alguns comandos inserem um caractere de dois-pontos (:) entre o nome e o valor do parâmetro booleano. Em parâmetros booleanos, esse caractere de dois-pontos é opcional. O exemplo a seguir desabilita o Conector de Recebimento "Contoso.com":

Set-ReceiveConnector "Contoso.com" -Enabled $False

Os parâmetros de opção são usados normalmente para indicar se o comando atual deve prosseguir com prompts adicionais ou para habilitar uma opção alternativa para o comando ser executado. Esse estado não é salvo entre comandos. Os parâmetros de opção são parecidos com os parâmetros booleanos, mas atendem a outros propósitos e exigem uma sintaxe diferente. Os parâmetros de opção não necessitam de um valor. Quando você especifica um parâmetro de opção em uma linha de comando sem um valor, o parâmetro é avaliado como $True.

Alguns cmdlets podem ser executados como se o parâmetro de opção fosse incluído na linha de comando, mesmo se você não o incluir. Este comportamento normalmente ocorre com o parâmetro de opção Confirm em cmdlets que pode fazer com que os dados sejam perdidos se forem inadvertidamente executados. No caso do parâmetro de opção Confirm nesse cmdlet, o cmdlet sempre irá solicitar a confirmação antes de ser executado a menos que você explicitamente diga ao cmdlet para não fazer, substituído o parâmetro de opção. Você pode substituir o parâmetro de opção incluindo o parâmetro de opção Confirm na linha de comando com um valor de :$False. Ao contrário de outros parâmetros, os dois pontos (:) são necessários entre os parâmetros de opção e o valor $False.

O primeiro exemplo a seguir instrui o cmdlet Start-EdgeSynchronization a exibir um prompt de confirmação antes de permitir que a sincronização do EdgeSync seja iniciada. O segundo exemplo instrui o cmdlet Remove-ReceiveConnector a não exibir um prompt de confirmação antes de excluir o Conector de recebimento "Contoso.com":

Start-EdgeSynchronization -Confirm
Remove-ReceiveConnector "Contoso.com" -Confirm:$False

Há diversos parâmetros do Windows PowerShell que são automaticamente adicionados a todos os comandos pelo Shell. Esses parâmetros executam funções que podem ser usadas com ou pelos comandos em que são executadas. A tabela a seguir lista todos os parâmetros comuns disponíveis no Shell. Três parâmetros adicionais, WhatIf, Confirm e ValidateOnly, também podem ser adicionados aos cmdlets. Para obter mais informações sobre esses parâmetros adicionais, consulte Comutadores WhatIf, Confirm e ValidateOnly.

Parâmetros comuns do Windows PowerShell no Shell de Gerenciamento do Exchange

Nome do parâmetro	Necessário	Tipo	Descrição
Debug	Opcional	System.Boolean	O parâmetro Debug instrui o comando para fornecer detalhes em nível de programador sobre a operação.
ErrorAction	Opcional	System.Enum	O parâmetro ErrorAction controla o comportamento do mando quando ocorre um erro. Os valores são: Continue, que é o valor padrão Stop SilentContinue Inquire, que pergunta ao usuário o que fazer
ErrorVariable	Opcional	System.String	O parâmetro ErrorVariable especifica o nome da variável que o comando usa para armazenar erros encontrados durante o processamento. Essa variável é preenchida, além de $ERROR.
OutVariable	Opcional	System.String	O parâmetro OutVariable especifica o nome da variável usa para objetos que saem desse comando. É o mesmo que canalizar o comando para Set-Variable <name> -Passthru:$true
Verbose	Opcional	System.Boolean	O parâmetro Verbose instrui o comando para fornecer informações detalhadas sobre a operação. Observação: A maior parte dos cmdlets Get só retornará as informações de resumo que contém as propriedades mais comumente usadas quando você executá-las. Para dizer ao cmdlet Get para retornar todas as informações detalhadas ao executar um comando, canalize o comando para o cmdlet Format-List. Para mais informações, consulte Pipelining e Trabalhando com Saída do Comando.