MSBTS_HostInstance.Install Method

  • Article

 

Installs a service for the given instance of the BizTalk host.

Method Declaration

The syntax shown is language neutral.

uint32 Install(string Logon, string Password, boolean GrantLogOnAsService, boolean IsGmsaAccount);

Parameters

Logon
String containing the logon information used by the host instance.

Password
String containing the password for the host.

GrantLogOnAsService
Boolean determining whether the 'Log On As Service' privilege should be automatically granted to the specified logon user or not. This flag only has effect when the HostType property is set to In-process.

IsGmsaAccount
Boolean determining whether the logon account is a Group Managed Service Account. If true, the password can be empty. This parameter is only available for BizTalk 2020 and above.

Note

Starting with BizTalk Server 2020 CU5, the IsGmsaAccount parameter is optional.

Return Value

This method returns an HRESULT indicating whether the method completed successfully.

Remarks

For samples illustrating the MSBTS_HostInstance class, see WMI Script Samples.

Requirements

Header: Declared in BTSWMISchemaXP.mof.

Namespace: Included in \root\MicrosoftBizTalkServer.