在 BizTalk Server 中安装和配置管理 REST API

项目
10/14/2023

什么是管理数据 API

管理数据 API 是终结点，可用于远程更新、添加和查询BizTalk Server环境中的不同项目的状态。终结点是使用 REST 添加的，并附带 swagger 定义。

从 BizTalk Server 2016 功能包 1 开始，有一个Windows PowerShell脚本用于安装这些 REST API 及其 swagger 定义。这些 API 发出 REST 调用以远程管理端口、业务流程、合作伙伴、协议、管道等。

若要查看可用的 API，请参阅 REST API 参考。

必备条件

在BizTalk Server上安装功能包 2 或更高版本的功能包。
在BizTalk Server上安装 IIS。在大多数BizTalk Server环境中，已安装 IIS。请参阅 BizTalk Server 2016 的硬件和软件要求。打开 Internet Information Services Manager，确认 IIS 已安装。

步骤 1：安装 REST API

以管理员身份运行Windows PowerShell (“开始”菜单>类型 PowerShell> 右键单击“>以管理员身份运行”) 。
转到 BizTalk 安装文件夹 (例如，键入： cd 'C:\Program Files (x86)\Microsoft BizTalk Server 2016\') 。

在以下文本中，将、mgmtServiceAppPool、domain/user、 password和 domain\group 替换为Default Web Site值：

FeaturePack.ConfigureServices.ps1 -Service management -WebSiteName '<Default Web Site>' -ApplicationPool <mgmtServiceAppPool> -ApplicationPoolUser <domain>\<user> -ApplicationPoolUserPassword <password> -AuthorizationRoles '<domain>\<group>, <domain>\<group>'

在以下示例中，我们使用 Default Web Site，创建名为 RESTAppPool的应用程序池，运行 appPool 作为bootcampbts2016\btsservice帐户，使用 BIZTALK-serviceacct 作为用户帐户密码，并为BizTalk Server管理员组授予权限。请务必输入以下内容，包括带空格的值的单引号：

FeaturePack.ConfigureServices.ps1 -Service management -WebSiteName 'Default Web Site' -ApplicationPool RESTAppPool -ApplicationPoolUser bootcampbts2016\btsservice -ApplicationPoolUserPassword  BIZTALK-serviceacct -AuthorizationRoles 'BOOTCAMPBTS2016\BizTalk Server Administrators'

完成后， BizTalkManagementService 应用程序在 IIS 中创建：
BizTalkManagementService 应用程序

若要确认它是否正常工作，请浏览到 http://localhost/BizTalkManagementService/swagger。如果系统提示登录，请使用在上一步中输入的域\组成员的帐户登录， (-AuthorizationRoles 'BOOTCAMPBTS2016\BizTalk Server Administrators') 。

警告

IIS 中的 BizTalkManagementService 应用程序使用 web.config 文件。 web.config 中的元素 区分大小写。因此，在执行Windows PowerShell脚本时，请务必输入-AuthorizationRoles正确的值大小写。如果不确定情况，可通过以下简单方法了解情况：

打开 “计算机管理”，然后展开“ 本地用户和组”。
选择“ 组”，向下滚动到 “SQLServer...” 组。
在以下示例中，请注意 ，BOOTCAMPBTS2016 全部为大写字母。如果看到所有大写字母，请在所有大写字母中输入计算机名称。

计算机名称位于所有 CAPS 中

现在，REST API 通过 IIS 公开，其他应用程序可以访问和执行它们。 REST API 参考列出了 API。

可以通过手动更新管理应用程序的根文件夹中 的web.config 文件来更改谁具有访问权限。例如，使用以下命令允许任何人访问 swagger 输出：

<authorization>
   <allow users="*" />
</authorization>

步骤 2：测试 API

在BizTalk Server，浏览到 http://localhost/BizTalkManagementService/swagger。
滚动到 “主机”，然后选择“ 显示/隐藏”。有一个 GET 命令;单击此行：
它显示详细信息。选择“ 试用”：
响应正文返回所有主机：

注意

如果浏览到 http://localhost/BizTalkManagementService，应收到 500 错误。这是一件好事。只需将添加到 /swagger URL 的末尾，即可看到可用的 REST API。

另请参阅

REST API 参考

功能包中的新增功能

通过