适用于:Windows Admin Center、Windows Admin Center 预览版
Windows 管理中心网关插件启用从工具或解决方案的 UI 到目标节点的 API 通信。 Windows 管理中心托管一个网关服务,该服务可从要在目标节点上执行的网关插件中继命令和脚本。 网关服务可以进行扩展,以包括支持其他协议(默认值除外)的自定义网关插件。
默认情况下,在 Windows 管理中心中包括这些网关插件:
- PowerShell 网关插件
- WMI 网关插件
如果你想要使用 PowerShell 或 WMI 以外的协议进行通信,例如使用 REST,你可以构建自己的网关插件。 网关插件从现有网关进程加载到单独的 AppDomain,但对权限使用相同级别的提升。
Note: 不熟悉不同的扩展类型? 了解有关扩展性体系结构和扩展类型的详细信息。
准备环境
如果尚未准备好,请通过安装所有项目所需的依赖项和全局必备组件来准备环境。
(c # 库创建网关插件)
若要创建自定义网关插件,请创建新的 c # 类,该类实现 IPlugIn 来自 Microsoft.ManagementExperience.FeatureInterfaces 命名空间的接口。
Note:
IFeature在早期版本的 SDK 中提供的接口现在已标记为过时。 所有网关插件开发应使用 IPlugIn (或(可选) HttpPlugIn 抽象类) 。
从 GitHub 下载示例
若要快速开始使用自定义网关插件,你可以从 Windows 管理中心 SDK GitHub 站点克隆或下载我们的示例 c # 插件项目的副本。
添加内容
将新内容添加到示例 c # 插件项目项目 (或自己的项目) 的克隆副本,以包含自定义 api,然后生成要在后续步骤中使用的自定义网关插件 DLL 文件。
部署用于测试的插件
通过将自定义网关插件的 DLL 加载到 Windows 管理中心网关进程来对其进行测试。
Windows 管理中心在 plugins 当前计算机的 "应用程序数据" 文件夹中的文件夹中查找所有插件 (使用 system.environment.specialfolder 枚举) 的 CommonApplicationData 值。 在 Windows 10 上,此位置是 C:\ProgramData\Server Management Experience 。 如果 plugins 文件夹尚不存在,您可以自行创建该文件夹。
Note: 可以通过更新 "StaticsFolder" 配置值来覆盖调试版本中的插件位置。 如果正在本地调试,则此设置位于桌面解决方案的 App.Config 中。
在此示例中 (插件文件夹内, C:\ProgramData\Server Management Experience\plugins)
- 在示例项目中,创建一个新文件夹,该文件夹的名称与
NameFeature自定义网关插件 DLL 中 (的属性值相同,Name即 "Uno" ) - 将自定义网关插件 DLL 文件复制到此新文件夹
- 重新启动 Windows 管理中心进程
Windows 管理员进程重新启动后,您将能够通过发出 GET、PUT、PATCH、DELETE 或 POST 来在自定义网关插件 DLL 中执行这些 Api。http(s)://{domain|localhost}/api/nodes/{node}/features/{feature name}/{identifier}
可选:附加到插件进行调试
在 Visual Studio 2017 的 "调试" 菜单中,选择 "附加到进程"。 在下一个窗口中,滚动到 "可用进程" 列表并选择 "SMEDesktop.exe",然后单击 "附加"。 调试器启动后,可以在功能代码中放置一个断点,然后演练上述 URL 格式。 对于我们的示例项目 (功能名称: "Sample Uno" ) URL 为: " http://localhost:6516/api/nodes/fake-server.my.domain.com/features/Sample Uno "
使用 Windows 管理中心 CLI 创建工具扩展
现在,我们需要创建一个可在其中调用自定义网关插件的工具扩展。 创建或浏览到要在其中存储项目文件的文件夹,打开命令提示符,然后将该文件夹设置为工作目录。 使用之前安装的 Windows 管理中心 CLI 创建新扩展,并使用以下语法:
wac create --company "{!Company Name}" --tool "{!Tool Name}"
| 值 | 说明 | 示例 |
|---|---|---|
{!Company Name} |
你的公司名称 (带有空格) | Contoso Inc |
{!Tool Name} |
你的工具名称 (带有空格) | Manage Foo Works |
下面是一个示例用法:
wac create --company "Contoso Inc" --tool "Manage Foo Works"
这将使用为工具指定的名称在当前工作目录中创建一个新文件夹,将所有必需的模板文件复制到你的项目中,并使用你的公司和工具名称配置文件。
接下来,将目录更改为刚创建的文件夹,然后通过运行以下命令安装所需的本地依赖项:
npm install
完成此操作后,已设置将新扩展加载到 Windows 管理中心所需的一切。
将你的工具扩展连接到你的自定义网关插件
现在,你已使用 Windows 管理中心 CLI 创建了扩展,接下来可以执行以下步骤,将你的工具扩展连接到自定义网关插件:
生成和加载扩展
接下来,构建扩展并将其加载到 Windows 管理中心。 打开一个命令窗口,将目录更改为你的源目录,然后你就可以生成了。
-
用 gulp 构建并提供服务:
gulp build gulp serve -p 4201
请注意:你需要选择当前可用的端口。 请确保不要尝试使用正运行着 Windows Admin Center 的端口。
通过将本地服务项目附加到 Windows Admin Center,可使项目旁加载到 Windows Admin Center 的本地实例以进行测试。
-
在 Web 浏览器中启动 Windows Admin Center
-
打开调试程序 (F12)
-
打开控制台,并键入以下命令:
MsftSme.sideLoad("http://localhost:4201") -
刷新 Web 浏览器
项目现在将显示在工具列表中,名称旁边标有(旁加载)。
面向不同版本的 Windows 管理中心 SDK
通过 SDK 更改和平台更改,使扩展保持最新状态非常简单。 阅读有关如何以不同版本的 WINDOWS 管理中心 SDK 为目标的信息。
历史资料。此文对应 2021-03-23 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 nwashburn-ms)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
