BizTalk Adapter Service PowerShell CmdLets - LobTarget

  • 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:

In Microsoft Azure BizTalk Services, BizTalk Adapter Service installs PowerShell cmdlets to perform common LOB Target tasks, including:

  • Get-LOBTarget

  • Remove-LOBTarget

  • Set-LOBTarget

  • New-LOBTarget

Get-LOBTarget

Get-LOBTarget returns a list of the LOB Targets on the BizTalk Adapter Service Service. Parameters include:

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 local Management Service:

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

or

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

If -ServerURL is specified, all the LOB Targets for that server are returned.

If -ServerURL is not specified, all the LOB Targets for the default BizTalk Adapter Service Runtime server are returned.

-Path String

Optional

The path to the LOB Target on the BizTalk Adapter Service Runtime Server. Path string options include:

  • Complete URL Path: https://MyServer/BAService/ManagementService/Namespace1/target1

  • Relative sub-path: /namespace1/target1

If -Path is specified, the specific LOB Target at that path is returned.

If -Path is not specified, all the LOB Targets on the default BizTalk Adapter Service Runtime server are returned.

-Export String

Optional

The folder and file name where the serialized configuration of the LOB Target will be stored.

If -Export is specified, the LOB Target serialized configuration will be written to a file.

-Namespace String

Optional

The Service Bus namespace for the LOB Target.

If -Namespace is specified, all the LOB Targets for that namespace are returned.

If -Namespace is not specified, all the LOB Targets for all the namespaces on the default BizTalk Adapter Service Runtime server are returned.

-LobRelay String

Optional

The path to the LOB Relay that hosts the LOB Targets.

If -LOB Relay is specified, all the LOB Targets hosted in that specific LOB Relay are returned.

-SkipCertCheck

Optional

Enter this cmdlet to skip the certificate check.

CommonParameters

Optional

Can be used with any cmdlet and are implemented by Windows PowerShell. They are not specific to BizTalk Adapter Service 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

// Returns all the LOB Targets from the default Runtime server:
Get-LOBTarget 

// Returns all the LOB Targets in the “ns1” Service Bus namespace from the default Runtime server:
Get-LOBTarget -namespace ns1

// Returns all the LOB Targets hosted at https://MyServer:8080/BAService:
Get-LOBTarget -ServerURL https://MyServer:8080/BAService

// Returns all the LOB Targets hosted in “myLobRelay” from the default Runtime server:
Get- LOBTarget -LobRelay myLobRelay

// Returns the LOB Targets at “/ns1/target1/targetA” from the default Runtime server:
Get-LOBTarget -path /ns1/target1/targetA

Additional examples are available by typing: get-help get-lobtarget -examples. get-help get-lobtarget -full provides more detailed information on this cmdlet.

Remove-LOBTarget

Remove-LOBTarget removes a LOB Target on the BizTalk Adapter Service Service. Parameters include:

Parameter

Requirement

Description

-Path String

Required

The path to the LOB Target on the BizTalk Adapter Service Runtime Server. Path string options include:

  • Complete URL Path: https://MyServer/BAService/ManagementService/Namespace1/target1

  • Relative sub-path: /namespace1/target1

If -Path is specified, the specific LOB Target at that path is removed.

If -Path is not specified, all the LOB Targets on the default BizTalk Adapter Service Runtime server are removed.

-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 local Management Service:

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

or

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

If -ServerURL is specified, all the LOB Targets for that server are removed.

If -ServerURL is not specified, all the LOB Targets for the default BizTalk Adapter Service Runtime server are removed.

-SkipCertCheck

Optional

Enter this cmdlet to skip the certificate check.

CommonParameters

Optional

Can be used with any cmdlet and are implemented by Windows PowerShell. They are not specific to BizTalk Adapter Service 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

// Removes all the LOB Targets from the default Runtime server:
Remove-LOBTarget

// Removes all the LOB Targets in the “ns1” Service Bus namespace from the default Runtime server:
Remove -LOBTarget -namespace ns1

// Removes all the LOB Targets hosted at https://MyServer:8080/BAService:
Remove -LOBTarget –ServerURL https://MyServer:8080/BAService

// Removes the relay path from the default Runtime server:
Remove -LOBTarget -path /relay1

Additional examples are available by typing: get-help remove-lobtarget -examples. get-help remove-lobtarget -full provides more detailed information on this cmdlet.

Set-LOBTarget

Set-LOBTarget changes an existing LOB Target on the BizTalk Adapter Service Service. Parameters include:

Parameter

Requirement

Description

-LobServerUrl String

Optional

The LOB Server URL to the LOB system.

If -LobServerUrl is specified, update the LOB Targets to use the specified LOB Server URL.

-UserName String

Optional

The user name to connect to the LOB system.

If -UserName is specified, updates the LOB Targets to use the specified LOB user name.

-Password String

Optional

The user name password to connect to the LOB system.

If -Password is specified, updates the LOB Targets to use the specified Password.

-Domain String

Optional

When the LobSecurityType cmdlet is set to ConfiguredWindowsCredential, enter the domain name if using a domain account.

If -Domain is specified, updates the LOB Targets to use the specified domain for the user account.

-LobSecurityType String

Optional

The security method used to connect to the LOB system. Options include:

  • CustomSoapHeader

  • ConfigureUsername

  • ConfiguredWindowsCredential, if using the SQL Server LOB system.

If -LobSecurityType is specified, updates the LOB Targets to use the specified security type.

-HeaderNamespace String

Optional

The namespace of the username header and the password header.

If -HeaderNamespace is specified, updates the LOB Targets to use the specified header namespace.

-UserNameHeader String

Optional

The username header.

If -UserNameHeader is specified, updates the LOB Targets to use the specified username header.

-PasswordHeader String

Optional

The password header.

If -PasswordHeader is specified, updates the LOB Targets to use the specified password header.

-Enable Boolean

Optional

Specifies to enable or disable the LOB Target. Options include:

  • True: Enables the LOB Target

  • False: Disabled the LOB Target

If -Enable is specified, all the LOB Targets for the default BizTalk Adapter Service Runtime server are updated.

-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 local Management Service:

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

or

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

If -ServerURL is specified, all the LOB Targets for that server are updated.

If -ServerURL is not specified, all the LOB Targets for the default BizTalk Adapter Service Runtime server are updated.

-Path String

Required

The path to the LOB Target on the BizTalk Adapter Service Runtime Server. Path string options include:

  • Complete URL Path: https://MyServer/BAService/ManagementService/Namespace1/target1

  • Relative sub-path: /namespace1/target1

If -Path is specified, the specific LOB Target at that path is updated.

If -Path is not specified, all the LOB Targets on the default BizTalk Adapter Service Runtime server are updated.

-InputObject LOB Target

Required

Specifies one or more LOB Targets to update. This value is specified in the input pipeline.

If -InputObject is specified, that specific LOB Target is updated.

-SkipCertCheck

Optional

Enter this cmdlet to skip the certificate check.

CommonParameters

Optional

Can be used with any cmdlet and are implemented by Windows PowerShell. They are not specific to BizTalk Adapter Service 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

// Updates all LOB Targets to use the MyUser account and the MyPassword password:
Set-LOBTarget -LOBUserName MyUser -LOBPassword MyPassword

// Enables all the LOB Targets:
Set-LOBTarget -Enable True

// Updates all the LOB Targets to use the https://MyServer:8080/BAService Runtime server URL:
Set-LOBTarget -ServerURL https://MyServer:8080/BAService

// Updates the LOB Target path to /relay1:
Set -LOBTarget -path /relay1

Additional examples are available by typing: get-help set-lobtarget -examples. get-help set-lobtarget -full provides more detailed information on this cmdlet.

New-LOBTarget

New-LOBTarget creates a LOB Target on the BizTalk Adapter Service Service. Parameters include:

Parameter

Requirement

Description

-RelayPath String

Optional

Specifies the relay path to be used by the new LOB Target. The LOB Target will be created under the relay specified.

If -RelayPath is specified, the new LOB Target will be created under the relay specified.

-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 local Management Service:

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

or

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

If -ServerURL is specified, the LOB Target for that server is created.

If -ServerURL is not specified, the LOB Target is created using the default BizTalk Adapter Service Runtime server.

-Import String

Required

Specifies a file name that contains serialized LOB Target configuration that has already been exported. A LOB Target can be exported in Server Explorer or by using the Get-LOB Target -Path String -Export String cmdlet.

If -Import is specified, the LOB Target configuration will be imported.

-InputObject LobTarget

Rquired

Specifies one or more LOB Targets to create. This value is specified in the input pipeline.

If -InputObject is specified, that specific LOB Target is created.

-SkipCertCheck

Optional

Enter this cmdlet to skip the certificate check.

CommonParameters

Optional

Can be used with any cmdlet and are implemented by Windows PowerShell. They are not specific to BizTalk Adapter Service 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

// Creates a new LOB Target from the MyFile serialized configuration in the default Runtime server:
New-LOBTarget -Import MyFile

// Creates a new LOB Target hosted at https://MyServer:8080/BAService:
New -LOBTarget -ServerURL https://MyServer:8080/BAService

// Creates a new LOB Target in the specified /relay1 relay path in the default Runtime server:
New -LOBTarget -RelayPath /relay1

Additional examples are available by typing: get-help new-lobtarget -examples. get-help new-lobtarget -full provides more detailed information on this cmdlet.

See Also

BizTalk Adapter Service PowerShell CmdLets - LobRelay
PowerShell Cmdlets for the BizTalk Adapter Service
LOB Security in BizTalk Adapter Service
about_CommonParameters