PowerShell Cmdlets for the BizTalk Adapter Service

 

Important

Microsoft Azure BizTalk Services (MABS) is being retired, and replaced with Azure Logic Apps. If you currently use MABS, then Move from BizTalk Services to Logic Appsprovides some guidance on moving your integration solutions to Logic Apps.

If you're brand new to Logic Apps, then we suggest getting started here:

• What are logic apps

• Create your first logic app, or quickly get started using a pre-built template

• View all the available connectors you can use in your logic apps

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 BizTalk Services setup file. See Install Azure BizTalk Services SDK.

Additional

• 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, select Yes is prompted to proceed.

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.

Additional

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

PowerShell Best Practices

Case sensitivity	PowerShell commands are not case-sensitive. As a result, focus on the correct syntax and spelling.
Cmdlet Parameter Shortcuts	By default, PowerShell allows any unique prefix for the cmdlet parameters. For example, -f, -fo and -for can all be used as a shortcut for the -ForceDelete parameter.
Install Runtime & Tools	Install on the same server. This option allows you to manage the BizTalk Adapter Service components in the cloud and use the PowerShell cmdlets (command-lets) on a central server. The Developer portion of the Setup should be installed on a separate computer. The goal is to separate the development tasks from the runtime tasks.
Service Bus Namespace	When using the –Namespace parameter, always enter the Service Bus namespace.
get-help cmdletName -full	Use -full to get detailed information on the cmdlet, including examples and a description of each parameter.
about_ topics	The PowerShell about_ help topics are available in text format at C:\Windows\System32\WindowsPowerShell\v1.0\en-US.

In This Section

BizTalk Adapter Service PowerShell CmdLets - LobRelay

BizTalk Adapter Service PowerShell CmdLets - LobTarget

General PowerShell Cmdlets for BizTalk Adapter Service

See Also

Windows PowerShell Cmdlet Help Topics
LOB Security in BizTalk Adapter Service
Using the BizTalk Adapter Service (BAS)