Declarar propriedades como parâmetros

  • Artigo

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

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

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

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

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

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

  • os parâmetros devem ser definidos como tipos de .NET Framework da Microsoft para fornecer uma melhor validação de parâmetro. Por exemplo, parâmetros que são restritos a um valor de um conjunto de valores devem ser definidos como um tipo de enumeração. Os parâmetros que usam um valor de Uniform Resource Identifier (URI) devem ser do tipo System. URI.

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

  • Você pode adicionar um parâmetro a qualquer número de conjuntos de parâmetros. Para obter mais informações sobre conjuntos de parâmetros, consulte conjuntos de parâmetros de cmdlet.

Windows PowerShell também fornece um conjunto de parâmetros comuns que estão automaticamente disponíveis para todos os cmdlets. Para obter mais informações sobre esses parâmetros e seus aliases, consulte parâmetros comuns do cmdlet.

Consulte Também

Parâmetros comuns do cmdlet

Tipos de parâmetro de cmdlet

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