Declaração de atributo de parâmetro

O atributo Parameter identifica uma propriedade pública da classe de cmdlet como um parâmetro de cmdlet.

Sintaxe

[Parameter()]
[Parameter(Named Parameters...)]

Parâmetros

Mandatory (System.Boolean) Parâmetro nomeado opcional. True indica que o parâmetro de cmdlet é necessário. Se um parâmetro necessário não for fornecido quando o cmdlet for invocado, Windows PowerShell solicitará um valor de parâmetro ao usuário. O padrão é false.

ParameterSetName (System.String) Parâmetro nomeado opcional. Especifica o conjunto de parâmetros ao que esse parâmetro de cmdlet pertence. Se nenhum conjunto de parâmetros for especificado, o parâmetro pertence a todos os conjuntos de parâmetros.

Position (System.Int32) Parâmetro nomeado opcional. Especifica a posição do parâmetro dentro de um Windows PowerShell comando.

ValueFromPipeline (System.Boolean) Parâmetro nomeado opcional. True indica que o parâmetro de cmdlet recebe seu valor de um objeto de pipeline. Especifique essa palavra-chave se o cmdlet acessar o objeto completo, não apenas uma propriedade do objeto . O padrão é false.

ValueFromPipelineByPropertyName (System.Boolean) Parâmetro nomeado opcional. True indica que o parâmetro cmdlet recebe seu valor de uma propriedade de um objeto de pipeline que tem o mesmo nome ou o mesmo alias que esse parâmetro. Por exemplo, se o cmdlet tiver um parâmetro e o objeto de pipeline também tiver uma propriedade , o valor da propriedade será atribuído ao parâmetro Name Name do Name Name cmdlet . O padrão é false.

ValueFromRemainingArguments (System.Boolean) Parâmetro nomeado opcional. True indica que o parâmetro cmdlet aceita todos os argumentos restantes que são passados para o cmdlet . O padrão é false.

HelpMessage Parâmetro nomeado opcional. Especifica uma breve descrição do parâmetro. Windows PowerShell exibe essa mensagem quando um cmdlet é executado e um parâmetro obrigatório não é especificado.

HelpMessageBaseName Parâmetro nomeado opcional. Especifica o local em que residem os identificadores de recurso. Por exemplo, esse parâmetro pode especificar um assembly de recurso que contém mensagens de Ajuda que você deseja localizado.

HelpMessageResourceId Parâmetro nomeado opcional. Especifica o identificador de recurso para uma mensagem de Ajuda.

Comentários

• Para obter mais informações sobre como declarar esse atributo, consulte How to Declare Cmdlet Parameters.

• Um cmdlet pode ter qualquer número de parâmetros. No entanto, para uma melhor experiência do usuário, limite o número de parâmetros.

• Os parâmetros devem ser declarados em propriedades ou campos não estáticos públicos. Os parâmetros devem ser declarados em propriedades. A propriedade deve ter um acessador de conjunto público e, se a palavra-chave ou for especificada, a propriedade deverá ter ValueFromPipeline ValueFromPipelineByPropertyName um acessador get público.

• Ao especificar parâmetros posicionais, limite o número de parâmetros posicionais em um parâmetro definido como menor que cinco. Além disso, os parâmetros posicionais não devem ser contíguos. As posições 5, 100 e 250 funcionam da mesma forma que as posições 0, 1 e 2.

• Quando a Position palavra-chave não é especificada, o parâmetro de cmdlet deve ser referenciado por seu nome.

• Ao usar conjuntos de parâmetros, observe o seguinte:

  • Cada conjunto de parâmetros deve ter pelo menos um parâmetro exclusivo. Um bom design de cmdlet indica que esse parâmetro exclusivo também deve ser obrigatório, se possível. Se o cmdlet foi projetado para ser executado sem parâmetros, o parâmetro exclusivo não pode ser obrigatório.

  • Nenhum conjunto de parâmetros deve conter mais de um parâmetro posicional com a mesma posição.

  • Apenas um parâmetro em um conjunto de parâmetros deve declarar ValueFromPipeline = true .

  • Vários parâmetros podem definir ValueFromPipelineByPropertyName = true .

• Para obter mais informações sobre as diretrizes para nomes de parâmetros, consulte Nomes de parâmetro de cmdlet.

• O atributo de parâmetro é definido pela classe System.Management.Automation.Parameterattribute.

Consulte Também

System.Management.Automation.Parameterattribute

Nomes de parâmetro de cmdlet

Writing a Windows PowerShell Cmdlet (Escrevendo um Cmdlet do Windows PowerShell)