Skip to content

Getting Started with Supervisor on Azure


This document provides information for deploying the Supervisor which will include the Sidra deployment on Azure.


The requirements for a proper deployment process are:

Supervisor's deployment

The deployment consists of two main steps:

  1. Deployment of Azure Active Directory (AAD) App registrations by executing the PowerShell script: Pre-deploy.ps1.
  2. Deployment of Sidra's Supervisor ARM template by using "Deploy a custom template" feature in Azure Portal.

Step 1. Pre-deployment script

A PowerShell script must be run before the Supervisor is deployed. This script will create some necessary resources to start Sidra's installation like:

  • Managed Identities*:

    • Identity with "Directory-readers" privileges
    • Identity with "Application-administrator" privileges
  • With the appRegistrationName assigned on the Pre-deploy.ps1 (recommendable name: <<CompanyName>>.Supervisor.<<Environment>> ), the script will create two Azure Active Directory (AAD) App registrations:

    • <<CompanyName>>.Supervisor.<<Environment>>.Manager. This app registration is used to log in to Azure when the DSU is deployed. These values secrets are stored in Supervisor keyVault:
      • AADApplications--Manager--Password
      • AADApplications--Manager--ApplicationId
    • <<CompanyName>>.Supervisor.<<Environment>>.IdentityServerAdAccess. This app registration is used by Authentication Service. When this app registration is created, the values secrets are also included in the Supervisor keyVault for authentication proposals. These secrets are:
      • AADApplications--IdentityServer--ApplicationId
      • AADApplications--IdentityServer--Password
      • AAD--0--ClientSecret
  • Azure Resource Group

*The managed identities will be stored inside the created Azure Resource Group.

Script parameters

For the PowerShell script to execute successfully, these are the necessary parameters:

Parameter name Description Example
appRegistrationName Name used in the creation of the ADD app registrations Sidra.Supervisor.Dev
subscriptionId The subscription's ID in which the resources are going to be deployed 000000-0000-0000-0000-000000000000
tenantId The tenant ID of the used subscription 000000-0000-0000-0000-000000000000
resourceGroupName Name of the resource group which will have the created managed identities. This name is going to be used later for Sidra's resource group name Sidra.Supervisor.Dev
resourceGroupLocation Location where the resource group is created northeurope

Execute Command

The steps for deploying the script are:

  1. Open a PowerShell 7 cmd.
  2. In the cmd, go to the location where the Pre-deploy.ps1 script is.
  3. Execute this command in the cmd:

    Remember to replace the parameter placeholders for the correct value that you prepared in the previous step.

    .\Pre-deploy.ps1 -appRegistrationName [appRegistrationName] -tenantId [tenantId] -subscriptionId [subscriptionId] -resourceGroupName [resourceGroupName] -resourceGroupLocation [resourceGroupLocation]


    .\Pre-deploy.ps1 -appRegistrationName "Sidra.Supervisor.Dev" -tenantId "000000-0000-0000-0000-000000000000" -subscriptionId "000000-0000-0000-0000-000000000000" -resourceGroupName "Sidra.Supervisor.Dev" -resourceGroupLocation "northeurope"
    • During the execution, a webpage from Azure is going to pop up in your default web browser asking you to log in. Log in with a user that satisfies the prerequisites mentioned before.
  4. Now, the command will output some values. This is an example:

    AAD applications
    App Registration Identity Server Id: 00000000-0000-0000-0000-000000000000
    App Registration Manager Id: 00000000-0000-0000-0000-000000000000

    From this script output, take note of those parameters values: App Registration Identity Server Id and App Registration Manager Id.

Step 2. Supervisor's ARM template deployment

Now that we have executed the pre-deployment script, we are ready to deploy the Supervisor:

  1. Go to Azure Portal and log in using the same user used for the execution of the pre-deployment script.
  2. Go to "Deploy a custom template" feature. You can use the top search bar in Azure Portal to search for it.
  3. Now click in "Build your own template in the editor".
  4. Replace the content on the template with Supervisor's ARM template (Supervisor.json file).

  5. Click "Save" button.

  6. Now, the following parameter's form of the Supervisor's ARM template will be displayed:

    Parameter name Description Example Required
    Subscription Selects the same subscription in which you executed the pre-deployment script Sidra
    Resource Group Sets the same name used in the pre-deploy script Sidra
    Region Selects the region in which you want to deploy Sidra's resources North Europe
    Deployment Prefix Sets a prefix value for the name of the deployed resources. Maximum length of four characters sds
    Environment Sets the environment name. Maximum length of four characters dev
    Supervisor Admin Email Sidra's administrator email [email protected]
    App Registration Identity Server Id Sets the value of "app_registration_identity_server/ApplicationId" from the output of the pre-deployment script 000000-0000-0000-0000-000000000000
    App Registration Manager Id Sets the value of "manager/ApplicationId" from the output of the pre-deployment script 000000-0000-0000-0000-000000000000
    Company Name Sets the company name Sidra
    Vnet Name Name of the existing VNET SidraVNET
    Vnet Resource Group Name of the existing VNET resource group Sidra.VNET
    Database Subnet Name Name of the existing database subnet SidraDB
    Container App Subnet Name Name of the existing container app subnet SidraContainerApp
    App Subnet Name Name of the existing app subnet SidraAppSubnet
    Storage Subnet Name Name of the existing storage subnet SidraStorage
    Default Subnet Name Name of the default subnet SidraDefSubnet
    Default Dsu Databricks Host Subnet Name Name of the default Databricks host subnet SidraHost
    Default Dsu Databricks Cluster Subnet Name Name of the default Databricks cluster subnet SidraCluster

    The optional parameters are those related with the integration in the Supervisor deployment of an existing VNET from the customer. By default, a new VNET is created with the Supervisor deployment.

  7. Click "Review + Create" button.

  8. Azure will start to validate the parameters. If everything is in order, the user will receive a notification stating Validation Passed.
  9. Click "Create" button.
  10. The deployment process will start and you will be redirect to the deployment page overview. Here you can check if the deployment is working well. When everything has finished you will see the message "Your deployment is complete.".
  11. Click to "Go to resource" and you will be redirect to the resource group with all the created resources.

With the steps above, Supervisor's deployment must be completed.

Enjoy your Supervisor's installation.


  1. I am having an error executing the pre-deployment script. What am I doing wrong?

    • If the error message states something like "Forbidden - Authorization_RequestDenied" or "The client <client> with <user-id> does not have authorization or an ABAC condition not fulfilled to perform action", check that the user you are using to execute the script has all the permissions explained in the prerequisites above.
    • If the error is something related with one o more of the parameters of the script, check that the values you are using are correct and similar to the examples this document provides.
  2. Azure Portal is displaying the message Validation failed after clicking the "Review + Create" button. What is happening?

    • Check that you are filling all the parameters of the form and that the values you are using are correct. Compare them with the examples this document provides.
  3. In the deployment overview page, I am having the message Deployment has failed or the variant Your deployment failed. Error image

    • Check which resource has failed from the resource list and read the error message (it must have a red exclamation with a link to "Error details"). Most of the times it will point what is wrong. Likely, the error will be related with one of the values used in the parameter's form. Check that the values used satisfy the conditions explained and are similar to the examples this document provides.

Last update: 2023-11-16