Get-AzureBizTalkBridgeSource

 

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:

You can have more than one sources associated with a bridge configuration. The Get-AzureBizTalkBridgeSource cmdlet gets the status of a specified source or all the sources deployed for the specified bridge.

  • If the status is returned as True, it denotes that the bridge source is started.

  • If the status is returned as False, it denotes that the bridge source is stopped.

Syntax

Get-AzureBizTalkBridgeSource –AcsNamespace <AcsNamespace> -IssuerName <IssuerName> -IssuerKey <IssuerKey> –DeploymentUri <DeploymentUri> -BridgePath <BridgePath> [-SourceName <SourceName>] [<CommonParameters>]

Parameters

Parameter

Requirement

Description

-AcsNamespace <AcsNamespace>

Required

The Access Control namespace associated with BizTalk Services.

-IssuerName <IssuerName>

Required

The Access Control issuer name. Specifying incorrect Access Control credentials results in an authentication error.

-IssuerKey <IssuerKey>

Required

The Access Control issuer key. Specifying incorrect Access Control credentials results in an authentication error.

-DeploymentUri <DeploymentUri>

Required

The deployment URI for BizTalk Services. For example, https://myDeploymentUri.biztalk.windows.net/default/. Specifying an incorrect URL results in an ObjectNotFound error.

-BridgePath <Path>

Required

The name of the bridge that you want to get the sources status for.

[-SourceName <SourceName>]

Optional

The bridge source name that you want the status for.

  • In case the specified source name does not exist, an error ObjectNotFound error message is returned.

  • In case source name is not provided, then the status for all the sources is returned.

  • In case a source name is not provided, and there are no sources listed for a particular bridge, then a message is returned stating that there are no sources for the bridge.

[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

  • Successfully retrieve the status of a bridge source

    Get-AzureBizTalkBridgeSource –AcsNamespace myACS -IssuerName owner –IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default -BridgePath XmlOneWayBridge1 –SourceName mySource

    Output

    Bridge - ‘https://myDeploymentUri.biztalk.windows.net/default/XmlOneWayBridge1/

    Source – mySource
    Status - True
    
  • Successfully retrieve status of all sources for a bridge

    Get-AzureBizTalkBridgeSource –AcsNamespace myACS -IssuerName owner –IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default -BridgePath XmlOneWayBridge1

    Output

    The status of sources for bridge ‘https://myDeploymentUri.biztalk.windows.net/default.servicebus.Windows.net/XmlOneWayBridge/’

    Source - mySource1
    Status - False
    ----------
    Source – mySource2
    Status - False                                                                                                               
    ----------
    Source – mySource3
    Status - True
    

See Also

PowerShell CmdLets to manage the BizTalk Service