Stop-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 source associated with a bridge configuration. The Stop-AzureBizTalkBridgeSource stops one or all the sources deployed as part of a bridge configuration. If the <SourceName> parameter is passed, then that particular source is stopped. Otherwise, all the sources for the bridge are stopped.

Syntax

Stop-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 stop the sources for.

[-SourceName <SourceName>]

Optional

The bridge source name that you want to stop.

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

  • In case source name is not provided, then all the sources for that bridge are stopped and a success message 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 stop a bridge source

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

    Output

    Source ‘mySource’ for bridge ‘https://myDeploymentUri.biztalk.windows.net/default/XmlOneWayBridge/’ has been stopped successfully

  • Error when the specified source does not exist

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

    Output

    ERROR: Source ‘nonExistantSource’ doesn’t exist for bridge ‘https://myDeploymentUri.biztalk.windows.net/default/XmlOneWayBridge/’

  • Successfully stopping multiple sources for a bridge

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

    Output

    The following sources were started for bridge ‘https://myDeploymentUri.biztalk.windows.net/default/XmlOneWayBridge1/’ mySource1mySource2mySource3

  • Behavior when no sources exist for the specified bridge

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

    Output

    No sources exist for bridge ‘https://myDeploymentUri.biztalk.windows.net/default/XmlOneWayBridge/’

See Also

PowerShell CmdLets to manage the BizTalk Service