Azure ARM

1.0 Overview

This document helps you to setup API credentials on Azure ARM.

Aviatrix Cloud Controller uses Azure APIs extensively to launch Aviatrix gateways, configure encrypted peering and other features.

In order to use Azure API, you need to first create an Aviatrix Cloud Account on the Aviatrix Cloud controller. This cloud account corresponds to a valid Azure account with API credentials.

The new Microsoft Azure (as opposed to Azure Classic) is significantly different in how applications are authenticated and authorized to interact with Azure Resource Manager APIs to manage resources, such as Virtual Machines, Network, Storage Accounts, etc.

This document describes how to obtain the necessary information, specifically Application ID, Application Key, and Application Directory ID to create an Aviatrix Cloud Account with step by step instructions. There are 3 sections, make sure you go through all of them.

Or you may refer to this video:

2.0 Azure Permission Setup for Aviatrix

Setting up Azure permission for Aviatrix involves three main steps.

  1. Register Aviatrix Controller Application with Azure Active Directory
  2. Grant Permissions
  3. Get Application ID, Application Key and Directory ID

Important: Complete the follow steps in order.

2.1 Step 1 – Register Aviatrix Controller Application

Login to the Azure Portal.

*Register Aviatrix Controller*

  1. From the Azure portal click on “All services” and search for “Azure Active Directory” and click on “Azure Active Directory”


  1. Click “App registrations”


  1. Click “+ New application registration”


  1. Name = Aviatrix Controller
  2. Application Type = Web app / API
  3. Sign-on URL = http://aviatrix
  4. Click Create.
  1. Done

2.2 Step 2 – Grant Permissions

*Grant Permissions*

  1. Login to the Azure portal
  2. On the top left, click All services, search for “Subscriptions”


  1. Copy the Subscription ID (to notepad or a convenient location)


  1. Click on the Subscription ID
  2. Then select “Access control (IAM)”.


  1. Click Add and then select the “Contributor” role.
  2. In the Select search field, type in “Aviatrix”. The Aviatrix Controller app should show up. Select this one and click Select towards to the bottom.

2.3 Step 3 – Get Application Information

Get Application Information

  1. From the Azure portal, click All services and search for “Azure Active Directory”.


  2. Retrieve the Application Directory ID.

    1. Scroll down the Azure Active Directory panel and Click on Properties


    1. Copy the “Directory ID” (to notepad or a convenient location)
  3. Retrieve the Application ID.

    1. Scroll up and click App registrations


    1. Copy the “Application ID”
  4. Retrieve the Application Key.

    1. Click Aviatrix Controller
    2. Click Settings


    1. Click Keys


    1. Enter in the following
      • Description = Aviatrix
      • Expires = Never expires
    2. Click Save
    3. Copy the key value (to notepad or a convenient location)
  5. Add App permissions.

    1. Click Required permissions -> Add


    1. Click Select an API -> Click Windows Azure Service Management API and click Select down below


    1. Click “Access Azure Service Management as organization user” and click Select


  6. Done

At this point you should have the following information.

Subscription ID From step 2
Directory ID From step 3
Application ID From step 3
Application Key From step 3