SALES: 1-800-867-1380

PowerShell Cmdlets in BizTalk Adapter Service

Updated: February 20, 2014

Install and use the PowerShell cmdlets in BizTalk Adapter Service.

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.

Install the PowerShell cmdlets

  1. Install Windows PowerShell 3.0.

  2. Run the WindowsAzureBizTalkServicesSetup.exe setup file.


  • The PowerShell cmdlets are automatically installed when the Tools option is selected during the setup. See Install Azure BizTalk Services SDK.

  • 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.

Use the PowerShell cmdlets

  1. Select Windows PowerShell and Run as Administrator.

    If User Account Control (UAC) is enabled, you may be prompted to proceed. Click Yes.

  2. Type: import-module "C:\Program Files\Windows Azure BizTalk Services Tools\Microsoft.BizTalk.Adapter.Services.Powershell.dll"

  3. Select Enter.

  4. To view the cmdlets, type: get-module. get-module displays the LOB Target and LOB Relay cmdlets supported by the BizTalk Adapter Service module.


  • The BizTalk Adapter Service Windows PowerShell module name is Microsoft.BizTalk.Adapter.Services.Powershell.dll. PowerShell scripts written using the Preview-version of the cmdlets may fail after upgrading.

  • 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

See Also

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

© 2014 Microsoft