Azure Cloud Explorer

Table of contents

• Overview
• Pre-requisites for Connecting to Azure
  • Obtaining credentials
  • Setting up permissions
• Connection setup
• Authentication types in Azure Cloud Explorer
  • Troubleshooting
    • Set Environment on macOS

Note: This feature is available in Ultimate and Team editions only.

Overview

DBeaver offers enhanced capabilities for managing and connecting to Azure databases directly from the DBeaver interface. The processes for creating and modifying connections are comprehensively detailed in the Cloud Explorer article. This guide explains the essential steps and requirements to connect to an Azure database using DBeaver.

Pre-requisites for Connecting to Azure

Obtaining credentials

To initiate a connection with Azure, you need to obtain your application credentials. For a comprehensive guide on registering your application with Azure, please refer to the Microsoft documentation.

Setting up permissions

Before you connect, ensure your Azure account is assigned the right roles and permissions. Properly setting up permissions on the Azure portal can help avoid potential access issues during the connection process. For more information on configuring roles and permissions, please consult the Azure roles guide.

Connection setup

1. Click on the Cloud Explorer button or navigate to Database -> Cloud Explorer in the menu.

2. Navigate to the Microsoft Azure section, choose the authentication type and enter your credentials.

   

Read more about available credentials types.

3. Click on Apply and Close. This action will save your input and close the settings window.

4. Once you have completed the previous step, you will notice Azure configuration appear in your configurations. This means you have successfully set up your Client_id, and Azure recognizes your application.

   

5. Select the database you want to connect to within the drop-down menu. This action initiates the process of connecting your selected database to DBeaver.

6. You will be redirected to the Microsoft authentication page. Here, you need to enter your login details.

7. After successful authentication, return to DBeaver to continue working with your connected database.

Authentication types in Azure Cloud Explorer

There are several credential types available in Azure Cloud Explorer.

Authentication Type	Description	Required credentials
Default credentials	Attempt to authenticate through several methods.	Read more about Default credentials
Enterprise application	Use credentials from your Azure Application.	- Client ID - Tenant ID
Client secret	Provide specific credentials from your Azure Application.	- Client ID - Client Secret - Tenant ID
Client certificate	Utilize certificate-based authentication with your Azure Application.	- Client ID - Tenant ID - Upload the relevant certificate

Troubleshooting

Set Environment on macOS

Issue - Launching DBeaver from Finder or Launchpad may result in incorrect environment variables.

Solution - Set the environment variables globally using launchctl:

1. Open Terminal.
2. Run:

   launchctl setenv AZURE_TENANT_ID	VARIABLE_VALUE
   launchctl setenv AZURE_CLIENT_ID	VARIABLE_VALUE
   launchctl setenv AZURE_CLIENT_SECRET VARIABLE_VALUE

3. Restart DBeaver.