Jak zadeklarować parametry polecenia cmdlet

Te przykłady pokazują, jak zadeklarować parametry nazwane, pozyacyjne, wymagane, opcjonalne i switch. Te przykłady pokazują również sposób definiowania aliasu parametru.

Jak zadeklarować nazwany parametr

  • Zdefiniuj właściwość publiczną, jak pokazano w poniższym kodzie. Po dodaniu atrybutu Parameter pomiń słowo Position kluczowe z atrybutu .

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

Aby uzyskać więcej informacji na temat atrybutu parametru, zobacz Deklaracja atrybutu parametru.

How to Declare a Positional Parameter

  • Zdefiniuj właściwość publiczną, jak pokazano w poniższym kodzie. Po dodaniu atrybutu Parameter ustaw słowo Position kluczowe na pozycję argumentu. Wartość 0 wskazuje pierwszą pozycję.

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

Aby uzyskać więcej informacji na temat atrybutu parametru, zobacz Deklaracja atrybutu parametru.

Jak zadeklarować obowiązkowy parametr

  • Zdefiniuj właściwość publiczną, jak pokazano w poniższym kodzie. Po dodaniu atrybutu Parameter ustaw słowo Mandatory kluczowe na true .

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

Aby uzyskać więcej informacji na temat atrybutu parametru, zobacz Deklaracja atrybutu parametru.

Jak zadeklarować opcjonalny parametr

  • Zdefiniuj właściwość publiczną, jak pokazano w poniższym kodzie. Podczas dodawania atrybutu Parameter pomiń słowo Mandatory kluczowe .

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

Jak zadeklarować parametr przełącznika

  • Zdefiniuj właściwość publiczną jako typ System.Management.Automation.SwitchParameter,a następnie zadeklaruj atrybut Parameter.

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

Aby uzyskać więcej informacji na temat atrybutu parametru, zobacz Deklaracja atrybutu parametru.

Jak zadeklarować parametr za pomocą aliasów

  • Zdefiniuj właściwość publiczną, jak pokazano w poniższym kodzie. Dodaj atrybut aliasu, który wyświetla aliasy dla parametru . W tym przykładzie dla tego samego parametru są definiowane trzy aliasy. Pierwszy alias zawiera skrót. Drugi i trzeci alias zapewniają nazwy, których można używać w różnych scenariuszach.

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

Aby uzyskać więcej informacji na temat atrybutu aliasu, zobacz Deklaracja atrybutu aliasu.

Zobacz też

System.Management.Automation.SwitchParameter

Parameter, deklaracja atrybutu

Alias, deklaracja atrybutu

Pisanie polecenia cmdlet programu Windows PowerShell