开发工具扩展

适用于:Windows Admin Center、Windows Admin Center 预览版

工具扩展是用户与 Windows Admin Center 交互以管理连接(如服务器或群集)的主要方式。 在 Windows Admin Center 主屏幕中单击某个连接,然后连接时,左侧导航窗格中会显示工具列表。 在你单击工具时,工具扩展将加载并在右侧窗格中显示。

在加载工具扩展时,它可以在目标服务器或群集上执行 WMI 调用或 PowerShell 脚本,并可以基于用户输入在 UI 中显示信息或执行命令。 工具扩展定义它应为其显示的解决方案,因此每个解决方案的工具集会不同。

注意

不熟悉其他扩展类型? 详细了解可扩展性体系结构和扩展类型

准备环境

请安装所有项目所需的依赖项和全局先决条件来准备环境(如果尚未这样做)。

使用 Windows Admin Center SDK 创建新的工具扩展

安装所有依赖项后,即可创建新的工具扩展。 创建或浏览到包含项目文件的文件夹,打开命令提示符,然后将该文件夹设置为工作目录。 通过之前安装的 Windows Admin Center SDK,使用以下语法创建新的扩展:

wac create --company "{!Company Name}" --tool "{!Tool Name}" --version latest
说明 示例
{!Company Name} 公司名称(带空格) Contoso Inc
{!Tool Name} 工具名称(带空格) Manage Foo Works

下面是一个示例用法:

wac create --company "Contoso Inc" --tool "Manage Foo Works" --version latest

这会使用为工具指定的名称在当前工作目录中创建一个新文件夹,将所有必要的模板文件复制到项目中,并使用公司和工具名称配置文件。

注意

此命令中的 --version 标志指定要针对的 Windows Admin Center SDK 版本。 了解如何针对不同版本的 Windows Admin Center SDK,使你的扩展与最新的 SDK 和平台变更保持同步。

接下来,将目录更改为刚创建的文件夹,然后通过运行以下命令安装所需的本地依赖项:

npm install

完成此操作后,你便已设置将新扩展加载到 Windows Admin Center 所需的所有步骤。

将内容添加到扩展

使用 Windows Admin Center SDK 创建扩展后,即可自定义内容。 有关可以执行的操作的示例,请参阅以下指南:

可以在开发人员指南中找到更多示例。 开发人员指南是一个功能齐全的解决方案扩展,可以旁加载到 Windows Admin Center,并包含丰富的示例功能和工具示例集合,你可以在自己的扩展中浏览和使用。

在 Windows Admin Center 设置的“高级”页上启用开发人员指南扩展。

自定义扩展的图标

可以自定义在工具列表中为扩展显示的图标。 为此,请修改扩展的 manifest.json 中的所有 icon 条目:

"icon": "{!icon-uri}",
说明 示例 URI
{!icon-uri} 图标资源的位置 assets/foo-icon.svg

注意:目前,在开发模式下旁加载扩展时,自定义图标不可见。 变通方法是删除 target 的内容,如下所示:

"target": "",

此配置仅对开发模式下的旁加载有效,因此请务必保留 target 中包含的值,然后在发布扩展之前对其进行还原。

生成并旁加载扩展

接下来,生成扩展并将其侧载到 Windows Admin Center。 打开命令窗口,将目录更改为源目录,然后就可以开始生成了。

  • 用 gulp 构建并提供服务:

    gulp build
    gulp serve --port 4201
    

请注意:你需要选择当前可用的端口。 请确保不要尝试使用正运行着 Windows Admin Center 的端口。

通过将本地服务项目附加到 Windows Admin Center,可使项目旁加载到 Windows Admin Center 的本地实例以进行测试。

  • 在 Web 浏览器中启动 Windows Admin Center

  • 打开调试程序 (F12)

  • 打开控制台,并键入以下命令:

    MsftSme.sideLoad("http://localhost:4201")
    
  • 刷新 Web 浏览器

项目现在将显示在工具列表中,名称旁边标有(旁加载)。