Como declarar conjuntos de parâmetros

Este exemplo mostra como definir dois conjuntos de parâmetros quando você declara os parâmetros para um cmdlet. Cada conjunto de parâmetros tem um parâmetro exclusivo e um parâmetro compartilhado que é usado por ambos os conjuntos de parâmetros. Para obter mais informações sobre conjuntos de parâmetros, incluindo como especificar o conjunto de parâmetros padrão, consulte conjuntos de parâmetros de cmdlet.

Importante

Sempre que possível, defina o parâmetro exclusivo de um conjunto de parâmetros como um parâmetro necessário. No entanto, se você quiser que o cmdlet seja executado sem especificar parâmetros, o parâmetro exclusivo poderá ser um parâmetro opcional. Por exemplo, o parâmetro exclusivo do Get-Command cmdlet é opcional.

Como definir dois conjuntos de parâmetros

1. Adicione a ParameterSet palavra-chave ao atributo de parâmetro para o parâmetro exclusivo do primeiro conjunto de parâmetros.

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

2. Adicione a ParameterSet palavra-chave ao atributo de parâmetro para o parâmetro exclusivo do segundo conjunto de parâmetros.

   [Parameter(Position = 0, Mandatory = true,
              ParameterSetName = "Test02")]
   public string ComputerName
   {
     get { return computerName; }
     set { computerName = value; }
   }
   private string computerName;
   

3. Para o parâmetro que pertence a ambos os conjuntos de parâmetros, adicione um atributo de parâmetro para cada conjunto de parâmetros e, em seguida, adicione a ParameterSet palavra-chave a cada conjunto. Em cada atributo de parâmetro, você pode especificar como esse parâmetro é definido. Um parâmetro pode ser opcional em um conjunto e obrigatório em outro.

   [Parameter(Mandatory= true, ParameterSetName = "Test01")]
   [Parameter(ParameterSetName = "Test02")]
   public string SharedParam
   {
       get { return sharedParam; }
       set { sharedParam = value; }
   }
   private string sharedParam;
   

Consulte Também

Conjuntos de parâmetros do cmdlet

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