ServiceBus Connect 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 Service Bus Connect 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.

SB Connect Powershell shortcut

Created automatically when Runtime & Tools are installed during Setup. The shortcut path is C:\Program Files\Microsoft ServiceBus Connect\Tools\ SBConnectPowershell.cmd.

The CMD file adds the local Runtime URL and sets the PowerShell execution policy to RemoteSigned. A different Runtime URL can be specified in this .cmd file or by using -ServerURL.

LobRelay PowerShell CmdLets and LobTarget PowerShell CmdLets provide more information on -ServerURL.

Using the Set-ExecutionPolicy Cmdlet provides more information on the execution policy.

powershell.exe.activation_config

Activation Configuration file is used by the Service Bus Connect PowerShell session. Sets the PowerShell session to use .NET Framework 4.0.

Activation Configuration Files provides more information on these files.

about_ topics

The PowerShell about_ help topics are available in text format at C:\Windows\System32\WindowsPowerShell\v1.0\en-US.