Parameter Attribute Declaration (Declaração do Atributo Parameter)

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

Sintaxe

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

Parâmetros

Mandatory(System.Boolean)Parâmetro de nome opcional. True indica que o parâmetro de cmdlet é necessário. Se não for fornecido um parâmetro necessário quando o cmdlet for invocado, Windows PowerShell solicita ao utilizador um valor de parâmetro. A predefinição é false.

ParameterSetName(System.String)Parâmetro de nome opcional. Especifica o parâmetro a que este parâmetro cmdlet pertence. Se não for especificado nenhum parâmetro definido, o parâmetro pertence a todos os conjuntos de parâmetros.

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

ValueFromPipeline(System.Boolean)Parâmetro de nome opcional. True indica que o parâmetro cmdlet tira o seu valor a partir de um objeto de pipeline. Especifique esta palavra-chave se o cmdlet acessa o objeto completo, e não apenas uma propriedade do objeto. A predefinição é false.

ValueFromPipelineByPropertyName(System.Boolean)Parâmetro de nome opcional. True indica que o parâmetro cmdlet tem o seu valor a partir de uma propriedade de um objeto de pipeline que tem o mesmo nome ou o mesmo pseudónimo deste parâmetro. Por exemplo, se o cmdlet tiver um Name parâmetro e o objeto de pipeline também tiver uma Name propriedade, o valor da propriedade é Name atribuído ao parâmetro do Name cmdlet. A predefinição é false.

ValueFromRemainingArguments(System.Boolean)Parâmetro de nome opcional. True indica que o parâmetro cmdlet aceita todos os argumentos restantes que são passados para o cmdlet. A predefinição é false.

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

HelpMessageBaseName Parâmetro opcional nomeado. Especifica o local onde residem os identificadores de recursos. Por exemplo, este parâmetro pode especificar um conjunto de recursos que contenha mensagens de ajuda que pretende localizar.

HelpMessageResourceId Parâmetro opcional nomeado. Especifica o identificador de recursos para uma mensagem de ajuda.

Observações

• Para obter mais informações sobre como declarar este atributo, consulte Como declarar parâmetros de cmdlet.

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

• Os parâmetros devem ser declarados em campos ou propriedades não estáticas públicas. Os parâmetros devem ser declarados sobre as propriedades. O imóvel deve ter um acessório de conjunto público, e se a ValueFromPipeline ValueFromPipelineByPropertyName palavra-chave ou palavra-chave for especificada, o imóvel deve ter um acessório público.

• Quando especificar parâmetros posicionais, limite o número de parâmetros posicionais num parâmetro definido para menos de cinco. E os parâmetros posicionais não têm de 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 for especificada, o parâmetro cmdlet deve ser referenciado pelo seu nome.

• Quando utilizar conjuntos de parâmetros, note o seguinte:

  • Cada parâmetro deve ter pelo menos um parâmetro único. Um bom design de cmdlet indica que este parâmetro único também deve ser obrigatório, se possível. Se o seu cmdlet for concebido para ser executado sem parâmetros, o parâmetro único não pode ser obrigatório.

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

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

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

• Para obter mais informações sobre as diretrizes para os nomes dos parâmetros, consulte os nomes dos parâmetros do Cmdlet.

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

Consulte também

System.Management.Automation.Parameterattribute

Nomes do parâmetro do cmdlet

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