托管 PowerShell 无法在同一程序集中看到 Cmdlet

Question

我正在尝试从我的 C# 代码运行 PowerShell 脚本，这将使用运行它们的程序集中的自定义 Cmdlet。这是代码：

using System;
using System.Management.Automation;

[Cmdlet(VerbsCommon.Get,"Hello")]
public class GetHelloCommand:Cmdlet
{
    protected override void EndProcessing()
    {
        WriteObject("Hello",true);
    }
}

class MainClass
{
    public static void Main(string[] args)
    {
        PowerShell powerShell=PowerShell.Create();
        powerShell.AddCommand("Get-Hello");
        foreach(string str in powerShell.AddCommand("Out-String").Invoke<string>())
            Console.WriteLine(str);
    }
}

当我尝试运行它时，我收到 CommandNotFoundException。 我的 Cmdlet 写错了吗？我需要做些什么才能在 PowerShell 或运行空间等中注册我的 Cmdlet 吗？

Answer 1

使用当前代码片段执行此操作的最简单方法如下：

using System; 
using System.Management.Automation; 

[Cmdlet(VerbsCommon.Get,"Hello")] 
public class GetHelloCommand:Cmdlet 
{ 
    protected override void EndProcessing() 
    { 
        WriteObject("Hello",true); 
    } 
} 

class MainClass 
{ 
    public static void Main(string[] args) 
    { 
        PowerShell powerShell=PowerShell.Create();

        // import commands from the current executing assembly
        powershell.AddCommand("Import-Module")
            .AddParameter("Assembly",
                  System.Reflection.Assembly.GetExecutingAssembly())
        powershell.Invoke()
        powershell.Commands.Clear()

        powershell.AddCommand("Get-Hello"); 
        foreach(string str in powerShell.AddCommand("Out-String").Invoke<string>()) 
            Console.WriteLine(str); 
    } 
} 

这里假设 PowerShell v2.0（您可以使用 $psversiontable 或按版权日期（应为 2009 年）检查控制台。）如果您使用的是 win7，则正在使用 v2。

Answer 2

另一种简单的方法是在运行空间配置中注册 cmdlet，使用此配置创建运行空间，然后使用该运行空间。

using System;
using System.Management.Automation;
using System.Management.Automation.Runspaces;

[Cmdlet(VerbsCommon.Get, "Hello")]
public class GetHelloCommand : Cmdlet
{
    protected override void EndProcessing()
    {
        WriteObject("Hello", true);
    }
}

class MainClass
{
    public static void Main(string[] args)
    {
        PowerShell powerShell = PowerShell.Create();
        var configuration = RunspaceConfiguration.Create();
        configuration.Cmdlets.Append(new CmdletConfigurationEntry[] { new CmdletConfigurationEntry("Get-Hello", typeof(GetHelloCommand), "") });
        powerShell.Runspace = RunspaceFactory.CreateRunspace(configuration);
        powerShell.Runspace.Open();

        powerShell.AddCommand("Get-Hello");
        foreach (string str in powerShell.AddCommand("Out-String").Invoke<string>())
            Console.WriteLine(str);
    }
}

为了以防万一，使用这种方法 cmdlet 类不必是公共的。

Answer 3

您确实需要先注册 cmdlet，然后才能在 Powershell 会话中使用它。您通常可以通过 Powershell 管理单元来完成此操作。以下是该过程的高级概述：

• 创建自定义 cmdlet（您已经完成了这部分）
• 创建包含并描述您的 cmdlet 的 Powershell 管理单元
• 使用 Installutil在系统上安装新的管理单元 使用
• Add-PSSnapin 将管理单元添加到特定的 Powershell 会话

MSDN 上有几篇有用的文章非常彻底地解释了该过程：

• 使用 Windows PowerShell 进行开发
• 如何创建 Windows PowerShell 管理单元

还有一个有关 ByteBlocks 的两部分系列，讨论编写自定义 cmdlet。该系列可能是您最好的选择，因为您似乎已经完成了与第 1 部分相同的工作。您也许可以仅使用第 2 部分作为快速参考，然后就可以开始了。

• 如何编写自定义 Cmdlet - 第 1 部分
• 如何编写自定义Cmdlet - 第 2 部分