Condividi tramite


Come dichiarare i parametri dei cmdlet

Questi esempi illustrano come dichiarare parametri denominati, posizionali, obbligatori, facoltativi e [switch] . Questi esempi illustrano anche come definire un alias di parametro.

Come dichiarare un parametro denominato

  • Definire una proprietà pubblica come illustrato nel codice seguente. Quando si aggiunge l'attributo Parameter, omettere la Position parola chiave dall'attributo .

    [Parameter()]
    public string UserName
    {
      get { return userName; }
      set { userName = value; }
    }
    private string userName;
    

Per altre informazioni sull'attributo Parameter, vedere Parameter Attribute Declaration.

Come dichiarare un parametro posizionale

  • Definire una proprietà pubblica come illustrato nel codice seguente. Quando si aggiunge l'attributo Parameter, impostare la Position parola chiave sulla posizione dell'argomento. Il valore 0 indica la prima posizione.

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

Per altre informazioni sull'attributo Parameter, vedere Parameter Attribute Declaration.

Come dichiarare un parametro obbligatorio

  • Definire una proprietà pubblica come illustrato nel codice seguente. Quando si aggiunge l'attributo Parameter, impostare la Mandatory parola chiave su true.

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

Per altre informazioni sull'attributo Parameter, vedere Parameter Attribute Declaration.

Come dichiarare un parametro facoltativo

  • Definire una proprietà pubblica come illustrato nel codice seguente. Quando si aggiunge l'attributo Parameter, omettere la Mandatory parola chiave .

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

Come dichiarare un [switch] parametro

  • Definire una proprietà pubblica come tipo System.Management.Automation.SwitchParameter e quindi dichiarare l'attributo Parameter.

    [Parameter(Position = 1)]
    public SwitchParameter GoodBye
    {
      get { return goodbye; }
      set { goodbye = value; }
    }
    private bool goodbye;
    

Per altre informazioni sull'attributo Parameter, vedere Parameter Attribute Declaration.

Come dichiarare un parametro con alias

  • Definire una proprietà pubblica come illustrato nel codice seguente. Aggiungere un attributo Alias che elenca gli alias per il parametro . In questo esempio vengono definiti tre alias per lo stesso parametro. Il primo alias fornisce un collegamento. I secondi e i terzi alias forniscono nomi che è possibile usare per scenari diversi.

    [Alias("UN","Writer","Editor")]
    [Parameter()]
    public string UserName
    {
      get { return userName; }
      set { userName = value; }
    }
    private string userName;
    

Per altre informazioni sull'attributo Alias, vedere Dichiarazione di attributo alias.

Vedere anche

System.Management.Automation.SwitchParameter

Dichiarazione dell'attributo parameter

Dichiarazione di attributo alias

Scrittura di un cmdlet di PowerShell Windows