Jak napisać polecenie cmdletHow to write a cmdlet

W tym artykule pokazano, jak napisać polecenie cmdlet.This article shows how to write a cmdlet. Send-GreetingPolecenie cmdlet przyjmuje jedną nazwę użytkownika jako dane wejściowe, a następnie zapisuje powitanie dla tego użytkownika.The Send-Greeting cmdlet takes a single user name as input and then writes a greeting to that user. Chociaż polecenie cmdlet nie wykonuje wielu zadań, w tym przykładzie pokazano główne sekcje polecenia cmdlet.Although the cmdlet does not do much work, this example demonstrates the major sections of a cmdlet.

Procedura zapisywania polecenia cmdletSteps to write a cmdlet

  1. Aby zadeklarować klasę jako polecenie cmdlet, należy użyć atrybutu cmdlet .To declare the class as a cmdlet, use the Cmdlet attribute. Atrybut cmdlet określa czasownik i rzeczownik dla nazwy polecenia cmdlet.The Cmdlet attribute specifies the verb and the noun for the cmdlet name.

    Aby uzyskać więcej informacji o atrybucie polecenia cmdlet , zobacz polecenie cmdletattribute.For more information about the Cmdlet attribute, see CmdletAttribute Declaration.

  2. Określ nazwę klasy.Specify the name of the class.

  3. Określ, że polecenie cmdlet pochodzi z jednej z następujących klas:Specify that the cmdlet derives from either of the following classes:

  4. Aby zdefiniować parametry dla polecenia cmdlet, należy użyć atrybutu Parameter .To define the parameters for the cmdlet, use the Parameter attribute. W takim przypadku określony jest tylko jeden wymagany parametr.In this case, only one required parameter is specified.

    Aby uzyskać więcej informacji na temat atrybutu parametru , zobacz deklaracjaattribute.For more information about the Parameter attribute, see ParameterAttribute Declaration.

  5. Zastąp metodę przetwarzania wejściowego, która przetwarza dane wejściowe.Override the input processing method that processes the input. W takim przypadku Metoda System. Management. Automation. cmdlet. ProcessRecord została zastąpiona.In this case, the System.Management.Automation.Cmdlet.ProcessRecord method is overridden.

  6. Aby napisać powitanie, użyj metody System. Management. Automation. cmdlet. WriteObject.To write the greeting, use the method System.Management.Automation.Cmdlet.WriteObject. Powitanie jest wyświetlane w następującym formacie:The greeting is displayed in the following format:

    Hello <UserName>!
    

PrzykładExample

using System.Management.Automation;  // Windows PowerShell assembly.

namespace SendGreeting
{
  // Declare the class as a cmdlet and specify the
  // appropriate verb and noun for the cmdlet name.
  [Cmdlet(VerbsCommunications.Send, "Greeting")]
  public class SendGreetingCommand : Cmdlet
  {
    // Declare the parameters for the cmdlet.
    [Parameter(Mandatory=true)]
    public string Name
    {
      get { return name; }
      set { name = value; }
    }
    private string name;

    // Override the ProcessRecord method to process
    // the supplied user name and write out a
    // greeting to the user by calling the WriteObject
    // method.
    protected override void ProcessRecord()
    {
      WriteObject("Hello " + name + "!");
    }
  }
}

Zobacz takżeSee also

System. Management. Automation. cmdletSystem.Management.Automation.Cmdlet

System. Management. Automation. PSCmdletSystem.Management.Automation.PSCmdlet

System. Management. Automation. cmdlet. ProcessRecordSystem.Management.Automation.Cmdlet.ProcessRecord

System. Management. Automation. cmdlet. WriteObjectSystem.Management.Automation.Cmdlet.WriteObject

Deklaracja poleceń cmdletCmdletAttribute Declaration

ParameterAttribute — deklaracjaParameterAttribute Declaration

Pisanie polecenia cmdlet programu Windows PowerShellWriting a Windows PowerShell Cmdlet