General PowerShell Cmdlets for BizTalk Adapter Service

  • Article

 

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:

The Get-BizTalkService cmdlet returns the BizTalk Services URL associated with the BizTalk Adapter Service runtime.

Syntax

Get-BizTalkService [-ServerUrl <String>] [-SkipCertCheck] [<CommonParameters>] 

Parameters

Parameter

Requirement

Description

-ServerUrl String

Optional

The BizTalk Adapter Service runtime URL of the BizTalk Adapter Service runtime server. The default BizTalk Adapter Service runtime server URL is the URL of local Management Service, which is:

https://localhost:8080/BAService/ManagementService/

or

https://localhost:8080/BAService/ManagementService/

  • If a valid server URL is specified, the associated BizTalk Services URL is returned.

  • If an invalid or no server URL is specified, an error is returned.

-SkipCertCheck

Optional

Use this parameter if you want to skip the certificate check.

CommonParameters

Optional

Can be used with any cmdlet and are implemented by Windows PowerShell. Options include:

  • -Verbose

  • -Debug

  • -ErrorActions

  • -ErrorVariable

  • -WarningAction

  • -WarningVariable

  • -OutBuffer

  • -OutVariable

get-help about_commonparameters provides detailed information about these common parameters. about_CommonParameters is also a good resource.

Examples

Here are some examples:

  • Successfully get the BizTalk Services URL associated with the BizTalk Adapter Service runtime

    Get-BizTalkService -ServerUrl https://localhost:8080/BAService/ManagementService.svc

    Output

    https://myDeploymentUrl.biztalk.windows.net/default

  • Error when specified BizTalk Adapter Service runtime URL does not exist

    Get-BizTalkService -ServerUrl https://MyServer:8080/BAService/ManagementService.svc

    Output

    ERROR: Unable to connect to the service using the specified server URL

See Also

PowerShell Cmdlets for the BizTalk Adapter Service