The Azure installation script enables you to install Orchestrator on one or multiple nodes.

Single Node Installation

To install Orchestrator on an Azure App Service perform the following steps:

1. In the Azure Portal, under App Services, create a new app service with a custom name such as UiPathOrchestrator. For more information, see Microsoft's official documentation.
2. Set the database connection string in the Configuration > Connection Strings of the web app, with the name "Default". For example, Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True.
3. Create an Azure AD application and service principal that can access your Orchestrator App Service and Resource Group. Optionally, ask your friendly DevOps team to provide you with an Azure Service Principal ID and Password that can access the App Service and associated Resource Group.
4. Extract the content of the UiPathOrchestrator.zip archive into a folder on your machine.

📘

Note:

The following step requires running a PowerShell script. To disable any prompts interrupting this task, run the Get-ChildItem *.ps1 -Recurse | Unblock-File command in the directory selected at Step 10.

5. Run the Publish-Orchestrator.ps1 script, in PowerShell, using the parameters described here. Check out this example.

🚧

Important!

• Before running the Publish-Orchestrator.ps1 script, make sure you uninstall the AzureRM PowerShell module. We recommend using the Az PowerShell module as an alternative. Having both AzureRM and Az modules installed at the same time is not supported.

• If the desired Az version is not detected, and AzureRM is present when running the script, you are prompted to confirm the AzureRM removal even on unattended installations.

• Upgrading to Az v6.0.0 when any previous version of the module is in use causes the following message to pop up: WARNING: The version 'x.x.x' of module 'Az.<Name>' is currently in use. Retry the operation after closing the applications. In order to solve this problem, make sure to execute Publish-Orchestrator.ps1 in a new PowerShell session.

6. Start the Orchestrator app service. Enjoy using Orchestrator on your Azure Portal.

Multi-node Installation

📘

Note:

Multi-node installations require the setup of the High Availability Add-on.

To install Orchestrator on multiple nodes on an Azure App Service perform the following steps:

1. In the Azure Portal, under App Services, create a new app service with a custom name such as UiPathOrchestrator. For more information, see Microsoft's official documentation.
2. Set the database connection string in the Configuration > Connection Strings of the web app, with the name "Default". For example, Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True.
3. Create an Azure AD application and service principal that can access your Orchestrator App Service and Resource Group. Optionally, ask your friendly DevOps team to provide you with an Azure Service Principal ID and Password that can access the App Service and associated Resource Group.
4. In the Scale out (App Service plan) tab, select the Scale to a specific instance count option and provide the desired Instance count.
5. Extract the content of the UiPathOrchestrator.zip archive into a folder on your machine.Extract the content of the UiPathOrchestrator.zip archive into a folder on your machine.

📘

Note:

The following step requires running a PowerShell script. To disable any prompts interrupting this task, run the Get-ChildItem *.ps1 -Recurse | Unblock-File command in the directory selected at Step 10.

6. Run the Publish-Orchestrator.ps1 the script, in PowerShell, using the parameters described here. Check out this example.

🚧

Important!

• Before running the Publish-Orchestrator.ps1 script, make sure you uninstall the AzureRM PowerShell module. We recommend using the Az PowerShell module as an alternative. Having both AzureRM and Az modules installed at the same time is not supported.

• If the desired Az version is not detected, and AzureRM is present when running the script, you are prompted to confirm the AzureRM removal even on unattended installations.

• Upgrading to Az v6.0.0 when any previous version of the module is in use causes the following message to pop up: WARNING: The version 'x.x.x' of module 'Az.<Name>' is currently in use. Retry the operation after closing the applications. In order to solve this problem, make sure to execute Publish-Orchestrator.ps1 in a new PowerShell session.

7. Start the Orchestrator app service. Enjoy using Orchestrator on your Azure Portal.