Cómo escribir un cmdletHow to write a cmdlet

En este artículo se muestra cómo escribir un cmdlet.This article shows how to write a cmdlet. El Send-Greeting cmdlet toma un nombre de usuario único como entrada y, a continuación, escribe un saludo para ese usuario.The Send-Greeting cmdlet takes a single user name as input and then writes a greeting to that user. Aunque el cmdlet no hace mucho trabajo, en este ejemplo se muestran las secciones principales de un cmdlet.Although the cmdlet does not do much work, this example demonstrates the major sections of a cmdlet.

Pasos para escribir un cmdletSteps to write a cmdlet

  1. Para declarar la clase como un cmdlet, use el atributo cmdlet .To declare the class as a cmdlet, use the Cmdlet attribute. El atributo cmdlet especifica el verbo y el nombre del cmdlet.The Cmdlet attribute specifies the verb and the noun for the cmdlet name.

    Para obtener más información sobre el atributo cmdlet , consulte declaración de CmdletAttribute.For more information about the Cmdlet attribute, see CmdletAttribute Declaration.

  2. Especifique el nombre de la clase.Specify the name of the class.

  3. Especifique que el cmdlet se derive de cualquiera de las clases siguientes:Specify that the cmdlet derives from either of the following classes:

  4. Para definir los parámetros del cmdlet, use el atributo Parameter .To define the parameters for the cmdlet, use the Parameter attribute. En este caso, solo se especifica un parámetro obligatorio.In this case, only one required parameter is specified.

    Para obtener más información sobre el atributo Parameter , vea declaración de ParameterAttribute.For more information about the Parameter attribute, see ParameterAttribute Declaration.

  5. Invalide el método de procesamiento de entrada que procesa la entrada.Override the input processing method that processes the input. En este caso, se invalida el método System. Management. Automation. cmdlet. ProcessRecord .In this case, the System.Management.Automation.Cmdlet.ProcessRecord method is overridden.

  6. Para escribir el saludo, use el método System. Management. Automation. cmdlet. writeObject.To write the greeting, use the method System.Management.Automation.Cmdlet.WriteObject. El saludo se muestra en el siguiente formato:The greeting is displayed in the following format:

    Hello <UserName>!
    

EjemploExample

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 + "!");
    }
  }
}

Consulte tambiénSee 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

Declaración de CmdletAttributeCmdletAttribute Declaration

Declaración de ParameterAttributeParameterAttribute Declaration

Escribir un cmdlet de Windows PowerShellWriting a Windows PowerShell Cmdlet