Installieren und Konfigurieren der Verwaltungs-REST-APIs in BizTalk Server

Artikel
10/14/2023

Was sind Verwaltungsdaten-APIs?

Verwaltungsdaten-APIs sind Endpunkte, mit denen Sie die status verschiedener Artefakte in Ihrer BizTalk Server-Umgebung remote aktualisieren, hinzufügen und abfragen können. Die Endpunkte werden mithilfe von REST hinzugefügt und enthalten eine Swaggerdefinition.

Ab BizTalk Server 2016 Feature Pack 1 gibt es ein Windows PowerShell-Skript, das diese REST-APIs und ihre Swaggerdefinitionen installiert. Diese APIs führen REST-Aufrufe aus, um Ports, Orchestrierungen, Partner, Vereinbarungen, Pipelines und vieles mehr remote zu verwalten.

Die verfügbaren APIs finden Sie in der REST-API-Referenz.

Voraussetzungen

Installieren Sie Feature Pack 2 oder höher auf Ihrem BizTalk Server.
Installieren Sie IIS auf dem BizTalk Server. In den meisten BizTalk Server Umgebungen ist IIS bereits installiert. Weitere Informationen finden Sie unter Hardware- und Softwareanforderungen für BizTalk Server 2016. Vergewissern Sie sich, dass IIS installiert ist, indem Sie den Internetinformationsdienste-Manager öffnen.

Schritt 1: Installieren der REST-APIs

Führen Sie Windows PowerShell als Administrator aus (Startmenü> geben Sie PowerShell> ein, indem Sie mit der rechten Maustaste auf Als Administrator ausführen klicken>).
Wechseln Sie zum BizTalk-Installationsordner (geben Sie z. B. Folgendes ein: cd 'C:\Program Files (x86)\Microsoft BizTalk Server 2016\').
Ersetzen Sie Default Web Siteim folgenden Text , mgmtServiceAppPool, domain/user, passwordund domain\group durch Ihre Werte:
```
FeaturePack.ConfigureServices.ps1 -Service management -WebSiteName '<Default Web Site>' -ApplicationPool <mgmtServiceAppPool> -ApplicationPoolUser <domain>\<user> -ApplicationPoolUserPassword <password> -AuthorizationRoles '<domain>\<group>, <domain>\<group>'
```
Im folgenden Beispiel verwenden wir , Default Web Siteerstellen einen Anwendungspool namens RESTAppPool, führen den appPool als bootcampbts2016\btsservice Konto aus, verwenden BIZTALK-serviceacct als Benutzerkontokennwort und erteilen der Gruppe BizTalk Server Administratoren Berechtigungen. Achten Sie darauf, Folgendes einzugeben, einschließlich der einzelnen Anführungszeichen, die Werte mit Leerzeichen umgeben:
```
FeaturePack.ConfigureServices.ps1 -Service management -WebSiteName 'Default Web Site' -ApplicationPool RESTAppPool -ApplicationPoolUser bootcampbts2016\btsservice -ApplicationPoolUserPassword  BIZTALK-serviceacct -AuthorizationRoles 'BOOTCAMPBTS2016\BizTalk Server Administrators'
```
Nach Abschluss des Vorgangs wird die BizTalkManagementService-Anwendung in IIS erstellt:
Um zu bestätigen, dass es funktioniert, navigieren Sie zu http://localhost/BizTalkManagementService/swagger. Wenn Sie zur Anmeldung aufgefordert werden, melden Sie sich mit einem Konto an, das Mitglied der Domäne\Gruppe ist, die Sie im vorherigen Schritt (-AuthorizationRoles 'BOOTCAMPBTS2016\BizTalk Server Administrators') eingegeben haben.

Warnung

Die BizTalkManagementService-Anwendung in IIS verwendet eine web.config-Datei. Bei Elementen in web.config wird die Groß-/Kleinschreibung beachtet. Wenn Sie also das Windows PowerShell Skript ausführen, achten Sie darauf, die richtige Groß-/Kleinschreibung für -AuthorizationRoles den Wert einzugeben. Wenn Sie sich des Falls nicht sicher sind, finden Sie hier eine einfache Möglichkeit, dies herauszufinden:

Öffnen Sie Computerverwaltung, und erweitern Sie Lokale Benutzer und Gruppen.
Wählen Sie Gruppen aus, und scrollen Sie nach unten zu den SQLServer...- Gruppen.
Beachten Sie im folgenden Beispiel, BOOTCAMPBTS2016 in allen Feststelltaste enthalten ist. Wenn alle Feststelltaste angezeigt werden, geben Sie den Computernamen in allen Feststelltaste ein.

Der Computername ist in allen CAPS enthalten.

Nachdem die REST-APIs nun über IIS verfügbar gemacht wurden, kann auf sie zugegriffen und von anderen Anwendungen ausgeführt werden. Die REST-API-Referenz listet die APIs auf.

Sie können ändern, wer Zugriff hat, indem Sie die web.config-Datei manuell aktualisieren, die sich im Stammordner der Verwaltungsanwendung befindet. Verwenden Sie beispielsweise Folgendes, um jedem Zugriff auf die swagger-Ausgabe zu gewähren:

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

Schritt 2: Testen der APIs

Navigieren Sie auf der BizTalk Server zu http://localhost/BizTalkManagementService/swagger.
Scrollen Sie zu Hosts, und wählen Sie Einblenden/Ausblenden aus. Es gibt einen GET-Befehl. Klicken Sie auf diese Zeile:
Es werden die Details angezeigt. Wählen Sie Ausprobieren aus:
Der Antworttext gibt alle Hosts zurück:

Hinweis

Wenn Sie zu http://localhost/BizTalkManagementServicenavigieren, sollte der Fehler 500 angezeigt werden. Das ist eine gute Sache. Fügen Sie einfach am Ende der URL hinzu /swagger , und Sie sehen die verfügbaren REST-APIs.

Weitere Informationen

REST-API-Referenz

Neuerungen im Feature Pack

Freigeben über