> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aviatrix.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Gather Information for Azure Onboarding

You must collect several IDs and a client secret associated with the Aviatrix
PaaS application registered in Azure. This information is needed to establish a
connection between Aviatrix PaaS and your Azure account.

When you register an application, a service principal is created for the
associated tenant. The service principal serves as the identity that the
Aviatrix PaaS application uses to securely access your Azure resources.

You need to collect the following information associated with the application
you register for Aviatrix PaaS in Azure. You enter the information in the
Aviatrix PaaS console when onboarding your cloud account.

* Subscription ID
* Application ID
* Directory ID
* Client Secret

You can register a new application in Azure or use an existing one.

* If you are *creating a new application/service principal in Azure*, follow the
  instructions in:
  [Create a Service Principal in Azure](#create-a-service-principal-in-azure)

* If you have an *existing application in Azure* that you want to connect with,
  follow the instructions in:
  [Use an Existing Application in Azure](#use-an-existing-application-in-azure)

## Required Permissions

Aviatrix PaaS onboarding of an Azure account requires the following permissions
to perform the associated tasks:

* Application Administrator, Cloud Application Administrator, or Global
  Administrator role Required to register an application to create a service
  principal.

* User Access Administrator or Owner role at subscription level Required to
  assign the Contributor role at the subscription level.

* Application Administrator, Cloud Application Administrator, or Global
  Administrator role Required to generate a client secret.

## Create a Service Principal in Azure

To onboard an Azure account, you must create a service principal that provides
an identity for Aviatrix PaaS within the Microsoft Entra ID tenant. This
identity allows Aviatrix PaaS automated and secure access to your Azure
resources.

The service principal is created when you register an application in Azure. You
must then assign a role and create a secret identifier for the application. As
you perform the following tasks in the Azure Portal, you will gather the
required onboarding information to enter in Aviatrix console.

1. [Register an application to create a service principal](#register-your-aviatrix-application)
   Collect the Application (client) ID and Directory (tenant) ID
2. [Assign a role to the application](#assign-a-role-to-the-aviatrix-application)
   Collect the Subscription ID and assign the Contributor role.
3. [Create a secret identifier for the application](#create-a-secret-identifier)
   Create the secret and collect the Client Secret Value.

### Register Your Aviatrix Application

Register a new application in Azure. This action creates the service principal
to be used for Aviatrix PaaS.

1. In the [Azure portal](https://portal.azure.com), go to *App registrations*.
2. Click *+ New registration* and enter a clear and memorable name for your
   Aviatrix application (service principal).
3. Select *Accounts in this organizational directory only,* and then click
   *Register*. The page displays details of your Aviatrix application
   registration.
   <img src="https://mintcdn.com/aviatrix-14b37c43/EV0VWzgSoSn4nUA6/docs/cloud/images/azure-app-dir-id-copy.png?fit=max&auto=format&n=EV0VWzgSoSn4nUA6&q=85&s=3c50bc18cefe379a56c31be2bcfee6f8" alt="app and directory IDs" width="603" height="384" data-path="docs/cloud/images/azure-app-dir-id-copy.png" />
4. Copy the *Application (client) ID* and *Directory (tenant) ID* of the new
   application into a text file and save the file. You will use these ID values
   later to onboard your Azure account in Aviatrix PaaS.

### Assign a Role to the Aviatrix Application

After registering the application to be used as the Aviatrix PaaS service
principal, assign this application a role to set up the connection between your
Azure account and your Aviatrix PaaS account.

1. In the Azure portal, search for and select "Subscriptions."

2. Identify the subscription you want to use and click the *Subscription Name*
   to open more details.

3. Copy the *Subscription ID* to the text file where you saved the Application
   ID and Directory ID. \[.text-left]
   <img src="https://mintcdn.com/aviatrix-14b37c43/EV0VWzgSoSn4nUA6/docs/cloud/images/azure-sub-id.png?fit=max&auto=format&n=EV0VWzgSoSn4nUA6&q=85&s=7435e3a178ef6be9285a29542ffc3f2d" alt="screenshot of subscriptions page in azure" width="598" height="223" data-path="docs/cloud/images/azure-sub-id.png" />

4. Select *Access control (IAM)* in the left navigation.
   <img src="https://mintcdn.com/aviatrix-14b37c43/EV0VWzgSoSn4nUA6/docs/cloud/images/azure-role-add.png?fit=max&auto=format&n=EV0VWzgSoSn4nUA6&q=85&s=ab202f09e9c2faac654a089a622e0f0e" alt="access control add role menu" width="580" height="644" data-path="docs/cloud/images/azure-role-add.png" />

5. On the Access control (IAM) page, click *+ Add > Add role assignment*.
   Alternatively, you can click Add role assignment, under *Grant access to this
   resource*.

6. On the Role tab, select *Privileged administrator roles*.
   <img src="https://mintcdn.com/aviatrix-14b37c43/Edj7hoOEnFtUHgGn/docs/cloud/images/sub-contrib-azure.png?fit=max&auto=format&n=Edj7hoOEnFtUHgGn&q=85&s=510b38d04b07da90e2f5f66fe99a52ac" alt="screenshot of add role assignment page in azure" width="799" height="508" data-path="docs/cloud/images/sub-contrib-azure.png" />

7. In the table, search for and select the *Contributor* role.

8. Click the *Members* tab and select *Assign access to: User, group, or service
   principal*. <img src="https://mintcdn.com/aviatrix-14b37c43/EV0VWzgSoSn4nUA6/docs/cloud/images/azure-select-mambers.png?fit=max&auto=format&n=EV0VWzgSoSn4nUA6&q=85&s=964589b6a62e81e85f2d7b6d4dd6beb3" alt="azure add role page" width="576" height="354" data-path="docs/cloud/images/azure-select-mambers.png" />

9. For the Members field, click *Select members* to open a list.

10. In the *Select members* pane, locate the name of the Aviatrix application
    that you previously registered.

11. Select your Aviatrix application and click *Select*.

12. On the Add role assignment page, click *Review + assign* at the bottom of the
    page. You might need to click *Review + assign* twice.

Your Aviatrix application is now assigned a Contributor role for your Azure
subscription.

### Create a Secret Identifier

After registering Aviatrix PaaS as an application and assigning it the
Contributor role, create a Secret identifier. Microsoft Entra ID uses this
Secret identifier to authenticate the Aviatrix PaaS application as a service
principal.

<Note>
  When you onboard your Azure account in Aviatrix PaaS console, you must enter
  this Secret Identifier value in the Onboard Cloud Account window.
</Note>

1. Navigate to *App registrations* and click the name of the application you are
   using.
2. Under Essentials, click *Add a certificate or secret*. \[.text-left]
   <img src="https://mintcdn.com/aviatrix-14b37c43/EV0VWzgSoSn4nUA6/docs/cloud/images/azure-essentials-secret-add.png?fit=max&auto=format&n=EV0VWzgSoSn4nUA6&q=85&s=bf6699fe8b4af06e88337935e13b9e80" alt="azure app registration essentials" width="603" height="384" data-path="docs/cloud/images/azure-essentials-secret-add.png" />
3. On the *Client secrets* tab, click *+New client secret*.

<img src="https://mintcdn.com/aviatrix-14b37c43/EV0VWzgSoSn4nUA6/docs/cloud/images/azure-client-secret-add.png?fit=max&auto=format&n=EV0VWzgSoSn4nUA6&q=85&s=026ee45065c233e6d3a982e8a20dcfbd" alt="client secrets tab" width="576" height="322" data-path="docs/cloud/images/azure-client-secret-add.png" />

4. On *Add a client secret*, enter:

* *Description*: Aviatrix
* *Expires*: Set the time period to meet your corporate requirements.
  <Tip>
    Make a note of the expiration date and use an alerting system to send a
    reminder before the client secret expires. Azure does not send an alert
    prior to invalidating the client secret. If the client secret expires, you
    can have issues with your Aviatrix PaaS connection.
  </Tip>

5. Click *Add*.
6. In the table on *Certificates & secrets > Client secrets*, copy and save the
   *Value* for the secret you created. This is the Client Secret you must enter
   in the Aviatrix Onboard Cloud Account page.
   <Warning>
     This is the only opportunity to save this Value. You cannot view it again
     after you leave the *Certificates & secrets* window. It is not stored in
     Azure or in Aviatrix PaaS.
   </Warning>

*Next Step*:
[Overview](/docs/cloud/platform-administration/onboard-offboard/azure-cloud-account-onboard)

## Use an Existing Application in Azure

If you already have an application in Azure that you want to use as a service
principal, you must associate it with your Aviatrix PaaS account.

Perform the following steps in Azure to collect the information needed to
connect with the Aviatrix PaaS console.

1. Log in to the [Azure portal](https://portal.azure.com) and search for
   "Subscriptions."
2. Copy the *Subscription ID* to a text file.
   <img src="https://mintcdn.com/aviatrix-14b37c43/EV0VWzgSoSn4nUA6/docs/cloud/images/azure-sub-id.png?fit=max&auto=format&n=EV0VWzgSoSn4nUA6&q=85&s=7435e3a178ef6be9285a29542ffc3f2d" alt="screenshot of Subscriptions page in Azure" width="598" height="223" data-path="docs/cloud/images/azure-sub-id.png" />
3. Search for and select *App registrations*.
4. Click the name of an existing registration and copy the *Application ID* and
   *Directory ID* into the text file with the Subscription ID.

<img src="https://mintcdn.com/aviatrix-14b37c43/EV0VWzgSoSn4nUA6/docs/cloud/images/azure-app-dir-id-copy.png?fit=max&auto=format&n=EV0VWzgSoSn4nUA6&q=85&s=3c50bc18cefe379a56c31be2bcfee6f8" alt="app and directory IDs" width="603" height="384" data-path="docs/cloud/images/azure-app-dir-id-copy.png" />

5. If you have a Client Secret (part of the Azure Secret Identifier), add it to
   the list of saved IDs. If you need to create a Client Secret, see
   [Create a Secret Identifier](#create-a-secret-identifier).

*Next Step*:
[Overview](/docs/cloud/platform-administration/onboard-offboard/azure-cloud-account-onboard)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.