在 BizTalk Server 中安裝和設定管理 REST API

發行項
10/14/2023

什麼是管理資料 API

管理資料 API 是可讓您從遠端更新、新增及查詢BizTalk Server環境中不同成品狀態的端點。端點會使用 REST 來新增，並隨附 Swagger 定義。

從 BizTalk Server 2016 Feature Pack 1 開始，有Windows PowerShell腳本可安裝這些 REST API 及其 Swagger 定義。這些 API 會進行 REST 呼叫，以遠端系統管理埠、協調流程、合作夥伴、合約、管線等等。

若要查看可用的 API，請參閱 REST API 參考。

必要條件

在您的BizTalk Server上安裝Feature Pack 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\') 。

在下列文字中，以您的值取代 Default Web Site 、 mgmtServiceAppPool 、 domain/user 、 password 和 domain\group ：

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 作為帳戶、使用 BIZTALK-serviceacct 作為 bootcampbts2016\btsservice 使用者帳戶密碼，並提供BizTalk Server Administrators 群組許可權。請務必輸入下列專案，包括空格括住值的單引號：

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 。如果系統提示您登入，請使用您在上一個步驟中輸入之 domain\group 成員的帳戶登入， -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 參考資料

Feature Pack 的新功能

共用方式為