Guides

Onboarding for Azure Subscriptions

Suggest Edits

❗️

Please read first:

Before proceeding with onboarding for this type of cloud account, you must ensure the required pre-onboarding steps have been completed first.

For more information on what these prerequisites are and how to address them, please refer to the Pre-Onboarding for Azure Subscriptions user guide.

Introduction

An Azure Subscription is a cloud account that provides access to Azure services and resources. It acts as a container for resources such as virtual machines, databases, and storage.

The account onboarding process follows a step-by-step flow with five steps, described in the list below. Users must complete every step by filling in the appropriate details so that they can proceed to the next step.

The onboarding flow for Azure cloud accounts covers the following main steps:

  1. Azure Cloud Account Type: Select the type of Azure cloud account that needs to be onboarded.
  2. Prerequisites: Select the cloud account scope, access type, and product(s).
  3. Add & Validate Credentials: Select the authentication type and provide the required Azure account credentials.
  4. Basic Settings: Select and/or input the basic settings for the cloud account.
  5. Advanced Settings (optional): This optional step allows users to add tags and set up any required governance configurations. Account governance configurations can also be done after the onboarding steps.

As users add all necessary details for each step in the onboarding flow, it will be marked as completed and no longer appears greyed out in the left sidebar.

Detailed onboarding steps are explained in the sections below.

📘

Note:

Before starting the onboarding process on the platform, make sure that you have followed and completed all the prerequisite steps in the GCP cloud portal. Refer to the PRE-ONBOARDING user guides for more information on how to complete these steps.

Onboarding Steps

Perform the following steps to onboard an Azure Subscription Account:

  1. Log in to the platform and on the left menu bar, go to Settings > Onboard Accounts.

    The Onboard Cloud Accounts starting page will appear. Here, users can select which cloud provider to onboard a new account for based on the available options.

📘

Note:

Users can also use the Dashboard button in the upper right corner of the page to go directly to the Account Governance Dashboard (Cloud Accounts) as a shortcut.

  1. To start the onboarding process, hover over the Azure option under Public Cloud Providers, and an Onboard button should appear. Select Onboard to proceed.

  2. The page for the first step of the onboarding workflow should appear – Azure Cloud Account Type. In this step, users must select the specific Azure cloud account type to onboard. You can select one of the following account types to be onboarded:

    • Subscription
    • Enterprise Agreement (EA Application)
    • Microsoft Partner Agreement (CSP Direct)

In this case, select Subscription.

  1. Click Next. The Prerequisites section appears.

  2. In the Select Cloud Account Scope field, select one of the following options:

    • Tenant: This scope allows the cloud account to be available only in the tenant it is onboarded to. This option is selected by default.
    • Account: This scope allows the cloud account to be available in all tenants.

  3. In the Select Access Type field, select one of the following options:

    • Read-Only: This option provides viewing access without the ability to make changes.

    • Read-Write: This option allows the users to view, modify, and manage resources.

  4. In the Select Product(s) field, select the products that will be accessible through this account. The available products are shown based on the product bundle that was chosen during the account master creation. For example, the Governance product bundle includes: FinOps, SecOps, and CloudOps.

  5. Click Next. The Add & Validate Credentials section appears.

  6. In the Add & Validate Credentials field, fill the following fields related to the credentials:

    • In the Tenant ID box, type the tenant ID.

    • In the Application ID box, type the application ID.

    • In the Application Secret box, type the application secret code.

    • Click Save & Validate.

If the validation is successful, then a success message will be displayed.

If the validation fails, then an error message will be displayed along with an option for View Log. You can click View Log to view the error details and then click Re-Validate to retry the validation.

📘

Note:

After the completion of successful validation, the Save & Validate button turns to Re-Validate. You can click Re-Validate to validate the account again.

  1. Click Next. The Basic Settings section appears.

  2. Fill the following basic details:

    • In the Subscription list, select the subscription name.

    • In the Subscription Type list, the subscription type is pre-filled. But based on your need, you can select another subscription type.

    • Click Validate.

    • In the Account Name box, the Azure account name is prefilled. Based on the need, you can modify the name.

    • In the Currency list, click to select a currency in which the billing data will be downloaded from the cloud provider, and click Ok.

    • Select the Privacy Policy checkbox to accept the terms and continue with the onboarding process.

    📘

    Note:

    The Account Name field should not exceed the maximum character limit of 50 characters including special characters.

  3. You can click Next to set up advanced settings or click Finish to complete the account onboarding. Please note that the step for configuring advanced settings is not mandatory and can be skipped.

  4. If you click Next, then the Advanced Settings section will be displayed.

    • In the Add/Import Cloud Account Tags section, do any of the following to fill in the tag details:
      In the Custom Tags field:
      • In the Key box, type the tag key.
      • In the Value box, type the tag value.
      • Lastly, click Add Tag. The added tag appears below.
        After clicking View Master Account/Tenant Tags:
      • This opens the Custom Tags dialog box where you can select the required tags and click Add Selected Tags. The selected tags will now show up for the account to be onboarded.
    • In the Governance Configuration field, click Edit to configure the required settings. Refer to Governance Configuration for detailed steps.

  1. Click Finish.

The Onboarding Status dialog box appears that shows the progress of account onboarding. You can click Go to the Dashboard to return to the Account Governance Dashboard.

📘

Note:

We request that users ensure any individual Subscriptions that are part of the Azure EA root account have not already been onboarded when onboarding the Azure EA root account. If you want all Subscriptions to be part of the Azure EA root account after onboarding it, please remove any individual Subscription first, then onboard the Azure EA root account.

If an individual Subscription has already been onboarded and is not required to be part of the EA root account, you can still onboard the EA root account without mapping the Subscription to it.

Please note that individual Subscriptions show PAYG costs, while Subscriptions onboarded under the EA root will reflect costs according to rates applied in the EA root account.

Governance Configuration

The Governance Configuration page includes many sections where configurations can be made. You need to select the configuration you want to apply to your onboarded account. All the available configuration sections are explained below. Refer to the relevant configuration and follow the steps. These governance configurations can be made while onboarding the account or can be done post onboarding.

FinOps

The configurations that can be done for FinOps are explained below.

Cost Anomaly

Perform the following steps to configure cost anomaly:

  1. Expand the Cost Anomaly section.

  2. Ensure that Anomaly Detection Sensitivity field is enabled (the slider is on the right side).

  3. In the Resource Category Sensitivity box, the settings are applied by default. If you want to edit the default setting, add the sensitivity based on which anomaly would be detected.

  4. In the Notification section, click Configure. The Notifications Settings dialog box appears.

    1. Select the Enable Notification checkbox. The Email Address, Webhook, and Microsoft Teams Webhook fields are displayed.
    2. In the Email Address box, type the email address of the user(s) and click Add.
    3. In the Webhook box, type the webhook link(s) and click Add.
    4. In the Microsoft Teams Webhook box, type the URL(s) for Microsoft Teams Webhook and click Add.
    5. Click Save & Apply.

Cost Optimization - Rate Based

To enable Azure Hybrid Benefits, click to expand the Cost Optimization - Rate Based section. Enable Azure Hybrid Benefits field by moving the slider towards right and then click Save.

SecOps

The configurations that can be done for SecOps are explained below.

Threat Management

To make configuration for threat detection, perform the following steps:

  1. Click to expand the Threat Management section.
  2. To configure Threat Real Time Sync, click Configure. A dialog box displays.
  3. In the Select Resource Group list, select the relevant option and click Ok.
  4. Click Configure corresponding to the resource group added in the previous step.
  5. Select either Create New or Select Existing.
    • If you select Create New, then in the Action Group Name box, type an action group name and then click Continue.
    • If you choose Select Existing, then in the Action Group list, select an appropriate option and then click Continue.
  6. Click Validate.
  7. Click Save & Exit.

If configuration is already made for Threat Management, then you can click View to see the existing configuration or you can click Delete to remove the configuration.

To configure notifications related to threat management, perform the following steps:

  1. In the Notification section, click Configure. The Notifications Settings dialog box appears.
  2. Select the Enable Notification checkbox. The Email Address, Webhook, and Microsoft Teams Webhook fields are displayed.
  3. In the Email Address box, type the email address of the user(s) and click Add.
  4. In the Webhook box, type the webhook link(s) and click Add.
  5. In the Microsoft Teams Webhook box, type the URL(s) for Microsoft Teams Webhook and click Add.
  6. Click Save & Apply.

Vulnerability Assessments

To configure notifications for Vulnerability Assessments, perform the following:

  1. In the Notification section, click Configure. The Notifications Settings dialog box appears.
  2. Select the Enable Notification checkbox. The Email Address, Webhook, and Microsoft Teams Webhook fields are displayed.
  3. In the Email Address box, type the email address of the user(s) and click Add.
  4. In the Webhook box, type the webhook link(s) and click Add.
  5. In the Microsoft Teams Webhook box, type the URL(s) for Microsoft Teams Webhook and click Add.
  6. Click Save & Apply.

CloudOps

The configurations that can be done for CloudOps are explained below.

Activity

To configure alerts, perform the following:

  1. Expand the Activity section.
  2. In the Activity Log Configuration section, click Configure. A dialog box appears.
  3. In the Resource Group list, select the relevant option(s) and click Ok.
    Next you will have to configure activity logs individually for the selected resource group(s).
  4. Click Configure corresponding to a resource group.
  5. Select either Create New or Select Existing.
    • If you select Create New, then in the Action Group Name box, type an action group name. In the Rule Name box, type the name of the rule and then click Continue.
    • If you choose Select Existing, then in the Action Group list, select an appropriate option. In the Rule Name box, type the name of the rule and then click Continue.
  6. Repeat steps 4 and 5 to configure other resource groups selected in step 3.
  7. If you want to apply default template for activities to monitor your Azure setup, then select the Apply Default Template checkbox.
  8. Click Validate.
  9. Click Save & Exit.

If configuration is already made for activities, then you can click View to see the existing configuration or you can click Delete to remove the configuration.

To configure notifications for activity:

  1. In the Notification section, click Configure. The Notifications Settings dialog box appears.
  2. Select the Enable Notification checkbox. The Email Address, Webhook, and Microsoft Teams Webhook fields are displayed.
  3. In the Email Address box, type the email address of the user(s) and click Add.
  4. In the Webhook box, type the webhook link(s) and click Add.
  5. In the Microsoft Teams Webhook box, type the URL(s) for Microsoft Teams Webhook and click Add.
  6. Click Save & Apply.

Patch Management

To configure workspace, expand the Patch Management section. In the Configure Workspace list, select relevant option(s) and click Ok, and then finally click Save.

Assessments

The configurations that can be done for Assessments are explained below.

Assessments Functionality

When a cloud account is onboarded, users can configure the auto-assessment functionality based on their requirements. Users can choose to either enable or disable the option for auto-assessment while an account is being onboarded (as part of account governance configurations). By default, the option to run an auto-assessment is disabled.

If a user disables the option for auto-assessment, no assessment will be triggered on the onboarded account. If a user enables the setting, it will be triggered automatically on the onboarded account.

If a cloud account is onboarded with auto-assessment disabled at first, but later the auto-assessment option is enabled, then the assessment will proceed to be triggered for that account.

  • If the auto-assessment option is already enabled, users can disable it before the auto-assessment gets triggered.
  • If the auto-assessment option is enabled and then the assessment is triggered, then after that point it cannot be disabled.

To enable auto assessments:

  1. Expand the Assessments Functionality section.
  2. In the Trigger Auto Assessment field, move the slider to right to enable it.
  3. Click Save.

Shared Functionality and Integrated Tools

The configurations that can be done for Shared Functionality and Integrated Tools (common across all products) are explained below.

Policy Engine

To configure the policy engine for an account, perform the following steps:

  1. Expand the Policy Engine section.
  2. In the Policy Engine list, click to select the policy engine for the account and click Ok.
  3. Click Save.

Monitoring

To configure monitoring of accounts, perform the following:

  1. Expand the Monitoring section.
  2. In the Metric Data Collection Interval field, select the frequency in which the metric data needs to be collected and click Save. The available options are 24 Hours (Daily), 8 Hours Once, and 4 Hours Once.
  3. Click Save.

To enable alerts:

  1. In the Alert section, click Configure. A dialog box appears.
  2. In the Resource Group list, select the relevant option(s) and then click Ok.
    Next you will have to configure alerts individually for the selected resource groups.
  3. Click Configure corresponding to a resource group.
  4. Select either Create New or Select Existing.
    • If you select Create New, then in the Action Group Name box, type a name for the new action group and then click Continue.
    • If you choose Select Existing, then in the Action Group list, select an appropriate option and then click Continue.
  5. Repeat steps 3 and 4 to configure other resource groups selected in step 2.
  6. If you want to apply default template for alerts to monitor your Azure Monitor setup, then select the Apply Default Template checkbox.
  7. Click Validate.
  8. Click Save & Exit.

If configuration is already made for alerts, then you can click View to see the existing configuration or you can click Delete to remove the configuration.

To configure notifications for monitoring alerts, perform the following:

  1. Click to expand the section, and then click Configure. The Notifications Settings dialog box appears.
  2. Select the Enable Notification checkbox. The Email Address, Webhook, and Microsoft Teams Webhook fields are displayed.
  3. In the Email Address box, type the email address of the user(s) and click Add.
  4. In the Webhook box, type the webhook link(s) and click Add.
  5. In the Microsoft Teams Webhook box, type the URL(s) for Microsoft Teams Webhook and click Add.
  6. Click Save & Apply.

Account Onboarding Using PowerShell Script

Overview

Users can utilize a PowerShell script that simplifies the process of onboarding new accounts into the platform by automating several critical steps. This allows for an efficient and error-free operation, ensuring that all required components are properly configured without the need for any manual intervention.

The steps involved in the onboarding process are:

  1. Selecting Azure Subscriptions
  2. Assigning roles
  3. Creating a service principal
  4. Registering the necessary resource providers

Prerequisites

Before going ahead with the automated process of onboarding Azure accounts, users must check for the following prerequisite conditions.

  1. First, check whether the Azure PowerShell module is installed. Run the command below to check for the Azure PowerShell module. 
    Get-Module -Name Az -ListAvailable
    • If Azure PowerShell module is not installed, then install it by running: 
     Install-Module -Name Az -AllowClobber -Scope CurrentUser  
 Import-Module Az
  2. Next, run the command below to check whether AzureAD module is installed. 
     Get-Module -Name AzureAD -ListAvailable
    • If AzureAD module is not listed, then install it by running: 
    Install-Module -Name AzureAD -AllowClobber -Scope CurrentUser
Import-Module AzureAD
  3. Users must have the appropriate permissions (i.e. Owner-level access in Subscription) to create applications and assign roles in Azure.

Script Description

The PowerShell script performs the following main tasks:

  1. Create a Service Principal: Facilitates the creation of a new service principal in Azure AD with a display name provided by the user.
  2. Select Azure Subscriptions: Allows the user to select one or multiple Azure Subscriptions or choose all enabled Subscriptions.
  3. Assign Roles to Service Principal: Assigns the selected roles (like Reader, Contributor, etc.) to the service principal across chosen Subscriptions.
  4. Register Azure Resource Providers: Registers a predefined list of Azure resource providers necessary for operations in the platform.

Refer to the PowerShell script below that can be used for onboarding. 

# Function to create Service Principal and generate a secret
Connect-AzureAD
function Create-ServicePrincipal {
    $displayName = Read-Host "Please enter a display name for the new Service Principal"
    if ([string]::IsNullOrWhiteSpace($displayName)) {
        Write-Host "No display name provided. Exiting function."
        return $null
    }
    try {
        $application = New-AzureADApplication -DisplayName $displayName
        Write-Host "Application created with ID: $($application.AppId)"
        
        $servicePrincipal = New-AzureADServicePrincipal -AppId $application.AppId
        Write-Host "Service Principal created with Application ID: $($application.AppId)"
        
        $startDate = Get-Date
        $endDate = $startDate.AddYears(1)
        $passwordCredential = New-AzureADApplicationPasswordCredential -ObjectId $application.ObjectId -CustomKeyIdentifier "Access" -StartDate $startDate -EndDate $endDate
        Write-Host "Secret created for Application. Value: $($passwordCredential.Value)"
        
        # Fetch tenant ID
        $tenantId = (Get-AzureADTenantDetail).ObjectId
        Write-Host "Tenant ID: $tenantId"
        
        return $application, $servicePrincipal, $passwordCredential, $tenantId
    } catch {
        Write-Host "Failed to create service principal or secret: $_"
        return $null
    }
}

# Example of calling the function
$application, $servicePrincipal, $secret, $tenantId = Create-ServicePrincipal
 Start-Sleep -Seconds 10
 #Function to list and select the subscriptions
 function Select-Subscription {
    param (
        [string]$title,
        [array]$subscriptions
    )
    Write-Host $title
    for ($i = 0; $i -lt $subscriptions.Count; $i++) {
        Write-Host "$($i+1) : $($subscriptions[$i].name) - $($subscriptions[$i].id)"
    }
    # Adding an option for selecting all subscriptions
    Write-Host "$($subscriptions.Count + 1) : All Subscriptions"
    $indices = Read-Host "Enter the indices of the subscriptions (comma separated, or select 'All'):"
    # Check if the user selected "All"
    if ($indices -eq $($subscriptions.Count + 1)) {
        return $subscriptions
    }
    else {
        $selectedIndices = $indices -split ',' | ForEach-Object { [int]$_ - 1 }
        $selectedSubscriptions = $selectedIndices | ForEach-Object { $subscriptions[$_] }
        return $selectedSubscriptions
    }
}
# Assuming $subs is a JSON string from the output of `az account list`
$subs = az account list --query "[?state=='Enabled']" --only-show-errors
$subs_ids = $subs | ConvertFrom-Json
$selectedSubscription = Select-Subscription -title "Please select a subscription:" -subscriptions $subs_ids
# Displaying the selected subscriptions
foreach ($sub in $selectedSubscription) {
    Write-Host "Selected subscription: $($sub.name) - $($sub.id)"
}
$selectedSubscription | Format-Table -Property Name, Id, State, IsDefault -AutoSize
#Function to define the roles
function Show-Menu {
    param (
        [string]$title,
        [hashtable]$menuItems,
        [bool]$allowMultiple = $false
    )
    Write-Host "`n$title"
    $menuItems.Keys | Sort-Object | ForEach-Object { Write-Host "$_ : $($menuItems[$_])" }
    if ($allowMultiple) {
        $input = Read-Host "Enter choices separated by commas (e.g., 1,2)"
        $choices = $input -split ',' | ForEach-Object { $_.Trim() }
    } else {
        $choices = @(Read-Host "Enter choice")
    }
    $selectedItems = $choices | ForEach-Object { $menuItems[$_] }
    return $selectedItems
}
# Define the possible role definitions in a hashtable
$roleDefinitions = @{
    "1" = "Reader"
    "2" = "Contributor"
    "3" = "Resource Policy Contributor"
}
# Display menu and get user choices
$selectedRoles = Show-Menu -title "Select Role Definitions" -menuItems $roleDefinitions -allowMultiple $true
# Display the selected roles
$selectedRoles | ForEach-Object { Write-Host "- $_" }
#Assining the role to the selected subscriptions 
foreach ($sub in $selectedSubscription) {
    $context = Set-AzContext -SubscriptionId $sub.id -ErrorAction SilentlyContinue
    if ($context) {
        Write-Host "Switched to subscription: $($sub.name)"
        # Assign each selected role to the service principal for the subscription
        foreach ($role in $selectedRoles) {
            try {
                # Make sure to use ServicePrincipal ObjectId
                $roleAssignment = New-AzRoleAssignment -ObjectId $servicePrincipal.ObjectId -RoleDefinitionName $role -Scope "/subscriptions/$($sub.id)" -ErrorAction Stop
                Write-Host "Successfully assigned $role to service principal $($servicePrincipal.AppId) in subscription $($sub.name)"
            } catch {
                Write-Host "Failed to assign $role to service principal $($servicePrincipal.AppId) in subscription $($sub.name): $_"
            }
        }
    }
}
#Registering the Mandatory Resources Providers for the selected subscription/subscriptions
$resourceProviders = @(
    "Microsoft.Authorization",
    "Microsoft.Billing",
    "Microsoft.Commerce",
    "Microsoft.Consumption",
    "Microsoft.CostManagement",
    "Microsoft.Insights",
    "Microsoft.Network",
    "Microsoft.PolicyInsights",
    "Microsoft.Security",
    "Microsoft.Compute",
    "Microsoft.ContainerInstance",
    "Microsoft.ContainerRegistry",
    "Microsoft.ContainerService",
    "Microsoft.DBforMySQL",
    "Microsoft.DBforPostgreSQL",
    "Microsoft.DevTestLab",
    "Microsoft.RecoveryServices",
    "Microsoft.SQL",
    "Microsoft.Storage",
    "Microsoft.Web"
)
foreach ($sub in $selectedSubscription) {                                        
    # Set the Azure context to the current subscription in the loop
    $context = Set-AzContext -SubscriptionId $sub.id -ErrorAction SilentlyContinue
	# Pause after setting the context to ensure it has been applied
	Start-Sleep -Seconds 10  
    if ($context) {
        Write-Host "Switched to subscription: $($sub.name)"
        # Now perform actions on the current subscription
        foreach ($provider in $resourceProviders) {
            try {
                $status = Get-AzResourceProvider -ProviderNamespace $provider
                if ($status.RegistrationState -eq "Registered") {
                    Write-Host "Resource provider $provider is already registered in $($sub.name)."
                } else {
                    Register-AzResourceProvider -ProviderNamespace $provider | Out-Null
                    Write-Host "Registered resource provider: $provider in $($sub.name)"
					# Wait after registering a provider to ensure the operation completes
					Start-Sleep -Seconds 20  
                }
            } catch {
                Write-Host "Failed to retrieve or register the resource provider $provider in $($sub.name). Error: $_"
            }
        }
    } else {
        Write-Host "Failed to set context to subscription: $($sub.name)"
    }
}
exit-PSSession

Onboarding Steps

Perform the following steps to complete the onboarding process for Azure cloud accounts using the PowerShell script:

  1. To create a service principal, when prompted, enter a display name for a new Azure AD application and service principal.

    The script creates the application and service principal, and generates a secret key valid for one year. You can view the tenant ID, application ID, and secret value (Note: We strongly recommend copying these values down in a notepad).

  2. When prompted, enter the indices of the Azure Subscription(s) for onboarding separated by commas, or choose all Subscriptions by entering a special index.

  3. When prompted, select one or more roles to assign to the service principal. It then assigns the selected roles to the service principal for each chosen Subscription.

  4. The script automatically attempts to register a set of required Azure resource providers if they are not already registered.

❗️

Error Handling:

The script includes error handling to provide feedback if any operation(s) fail, such as role assignments or resource provider registration.

Updated 4 months ago