PowerShell Cmdlets - BizTalk Adapter Service
Updated: February 20, 2014
PowerShell is a Windows command-line shell typically used by system administrators. The BizTalk Adapter Service Runtime Server utilizes the cmdlet (command-let) ability of PowerShell to expose the LOB Relay and LOB Target entities. Using PowerShell, Administrators can manage the Runtime Service and these LOB entities.
To install the PowerShell cmdlets
Install Windows PowerShell 3.0. Then, run the WindowsAzureBizTalkServicesSetup.exe setup file. The PowerShell cmdlets are automatically installed when the Tools option is selected during the setup. Install Windows Azure BizTalk Services SDK provides the setup steps. When the installation completes, the C:\Program Files\Windows Azure BizTalk Services Tools folder is created. This folder contains the BizTalk Adapter Service Runtime PowerShell module.
To use the PowerShell cmdlets
|The BizTalk Adapter Service Windows PowerShell module name is Microsoft.BizTalk.Adapter.Services.Powershell.dll. As a result, PowerShell scripts written using the Preview-version of the cmdlets may fail after upgrading.|
When you install Windows Azure BizTalk Services Tools, the Microsoft.BizTalk.Adapter.Services.Powershell.dll PowerShell module is also installed. To use the BizTalk Services cmdlets, execute the Import-Module cmdlet:
Select Windows PowerShell and Run as Administrator.
If User Account Control (UAC) is enabled, you may be prompted to proceed. Click Yes.
Type: import-module "C:\Program Files\Windows Azure BizTalk Services Tools\Microsoft.BizTalk.Adapter.Services.Powershell.dll"
To view the cmdlets, type: get-module. get-module displays the LOB Target and LOB Relay cmdlets supported by the BizTalk Adapter Service module.
To use the individual BizTalk Adapter Service PowerShell cmdlets, refer to the links below.
|When using import-module, modules exist only when the PowerShell command window is open; which is the current PowerShell session. When the PowerShell command window is closed, the session is closed and the module is removed.|
In This Section
© 2013 Microsoft Corporation. All rights reserved.