BizTalk Serverで管理 REST API をインストールして構成する

[アーティクル]
07/21/2023

管理データ API とは

管理データ API は、BizTalk Server環境内のさまざまな成果物の状態をリモートで更新、追加、クエリできるエンドポイントです。エンドポイントは REST を使用して追加され、swagger 定義が付属しています。

BizTalk Server 2016 Feature Pack 1 以降では、これらの REST API とその swagger 定義をインストールするWindows PowerShell スクリプトがあります。これらの API は、ポート、オーケストレーション、パートナー、契約、パイプラインなどをリモートで管理するための REST 呼び出しを行います。

使用可能な API については、 REST API リファレンスを参照してください。

前提条件

BizTalk Serverに Feature Pack 2 以降の機能パックをインストールします。
BizTalk Serverに IIS をインストールします。ほとんどのBizTalk Server環境では、IIS は既にインストールされています。「BizTalk Server 2016 のハードウェアとソフトウェアの要件」を参照してください。 インターネットインフォメーションサービスマネージャーを開いて IIS がインストールされていることを確認します。

手順 1: REST API をインストールする

Windows PowerShell管理者として実行します ([スタート] メニュー>に「PowerShell>」と入力し、[管理者として実行] を右クリックします>)。
BizTalk インストールフォルダーに移動します (例: と入力します cd 'C:\Program Files (x86)\Microsoft BizTalk Server 2016\')。
次のテキストで、、mgmtServiceAppPooldomain/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 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 内に作成されます。
動作していることを確認するには、を参照します http://localhost/BizTalkManagementService/swagger。サインインを求められた場合は、前の手順 (-AuthorizationRoles 'BOOTCAMPBTS2016\BizTalk Server Administrators') で入力した domain\group のメンバーであるアカウントでサインインします。

警告

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 コマンドがあります。次の行をクリックします。
詳細が表示されます。 [ 試してみる] を選択します。
応答本文は、すべてのホストを返します。

Note

を http://localhost/BizTalkManagementService参照すると、500 エラーが発生します。それは良いことです。 URL の末尾にを追加 /swagger するだけで、使用可能な REST API が表示されます。

こちらもご覧ください

REST API リファレンス

Feature Pack の新機能

次の方法で共有