PowerShell CmdLets to manage the BizTalk 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

This section lists the PowerShell cmdlets for management operations on BizTalk Services. BizTalk Services also provides PowerShell cmdlets for managing BizTalk Adapter Service. See PowerShell Cmdlets for the BizTalk Adapter Service.

Install the PowerShell Cmdlets

To install the PowerShell cmdlets:

1. Install the Microsoft Azure BizTalk Services SDK. See Install Azure BizTalk Services SDK for instructions.

2. Open the PowerShell window with administrator privileges.

3. Run import-module to import the BizTalk Services module to the current session.

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

   Note

   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.

   Warning

   If you used these PowerShell cmdlets in the Preview release of the Microsoft Azure BizTalk Services SDK to build PowerShell scripts, you must update those to include the right import path.

Sample PowerShell Cmdlets

You can download Azure BizTalk Service Management Sample that demonstrates how to use the PowerShell cmdlets. It also demonstrates use of some sample cmdlets that can be used for backing up and restoring BizTalk Services, retrieving BizTalk Services properties, and syncing Access Control keys.

In This Section

• Get-AzureBizTalkBridge

• Remove-AzureBizTalkBridge

• Add-AzureBizTalkArtifactXmlSchema

• Add-AzureBizTalkArtifactTransform

• Add-AzureBizTalkArtifactAssembly

• Add-AzureBizTalkArtifactCertificate

• Get-AzureBizTalkArtifact

• Save-AzureBizTalkArtifact

• Remove-AzureBizTalkArtifact

• Start-AzureBizTalkBridgeSource

• Stop-AzureBizTalkBridgeSource

• Get-AzureBizTalkBridgeSource

• Restart-AzureBizTalkService

• Clear-AzureBizTalkTrackingStore

See Also

PowerShell Cmdlets for the BizTalk Adapter Service