Declaring Properties as Parameters (Declarar Propriedades como Parâmetros)

  • Artigo

Este tópico fornece informações básicas que deve entender antes de declarar os parâmetros de um cmdlet.

Para declarar os parâmetros de um cmdlet dentro da sua classe cmdlet, defina as propriedades públicas que representam cada parâmetro e, em seguida, adicione um ou mais atributos parâmetros a cada propriedade. O tempo de execução Windows PowerShell utiliza os atributos parâmetro para identificar a propriedade como um parâmetro cmdlet. A sintaxe básica para declarar o atributo parâmetro é [Parameter()] .

Aqui está um exemplo de uma propriedade definida como um parâmetro necessário.

[Parameter(Position = 0, Mandatory = true)]
public string UserName
{
  get { return userName; }
  set { userName = value; }
}
private string userName;

Aqui estão algumas coisas para lembrar sobre parâmetros.

  • Um parâmetro deve ser explicitamente marcado como público. Parâmetros que não são marcados como incumprimento público para interno e não serão encontrados pelo tempo de execução Windows PowerShell.

  • Os parâmetros devem ser definidos como tipos de .NET Framework da Microsoft para fornecer uma melhor validação de parâmetros. Por exemplo, os parâmetros que se limitam a um valor de um conjunto de valores devem ser definidos como um tipo de enumeração. Os parâmetros que assumem um valor uniforme de identificador de recursos (URI) devem ser do tipo System.Uri.

  • Evite parâmetros básicos de cadeia para todas as propriedades de texto de forma livre.

  • Pode adicionar um parâmetro a qualquer número de parâmetros. Para obter mais informações sobre os conjuntos de parâmetros, consulte os conjuntos de parâmetros do Cmdlet.

Windows PowerShell também fornece um conjunto de parâmetros comuns que estão automaticamente disponíveis para cada cmdlet. Para obter mais informações sobre estes parâmetros e seus pseudónimos, consulte os Parâmetros Comuns do Comandante.

Consulte também

Parâmetros comuns do Cmdlet

Tipos de Parâmetro Cmdlet

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