Authenticate Python apps to Azure services during local development using developer accounts

During local development, applications need to authenticate to Azure to use different Azure services. Authenticate locally using one of these approaches:

• Use a developer account with one of the developer tools supported by the Azure Identity library.
• Use a broker to manage credentials.
• Use a service principal.

This article explains how to authenticate using a developer account with tools supported by the Azure Identity library. In the sections ahead, you learn:

• How to use Microsoft Entra groups to efficiently manage permissions for multiple developer accounts.
• How to assign roles to developer accounts to scope permissions.
• How to sign-in to supported local development tools.
• How to authenticate using a developer account from your app code.

Supported developer tools for authentication

For an app to authenticate to Azure during local development using the developer's Azure credentials, the developer must be signed-in to Azure from one of the following developer tools:

• Azure CLI
• Azure Developer CLI
• Azure PowerShell
• Visual Studio Code

The Azure Identity library can detect that the developer is signed-in from one of these tools. The library can then obtain the Microsoft Entra access token via the tool to authenticate the app to Azure as the signed-in user.

This approach takes advantage of the developer's existing Azure accounts to streamline the authentication process. However, a developer's account likely has more permissions than required by the app, therefore exceeding the permissions the app runs with in production. As an alternative, you can create application service principals to use during local development, which can be scoped to have only the access needed by the app.

Create a Microsoft Entra group for local development

Create a Microsoft Entra group to encapsulate the roles (permissions) the app needs in local development rather than assigning the roles to individual service principal objects. This approach offers the following advantages:

• Every developer has the same roles assigned at the group level.
• If a new role is needed for the app, it only needs to be added to the group for the app.
• If a new developer joins the team, a new application service principal is created for the developer and added to the group, ensuring the developer has the right permissions to work on the app.

Azure portal

1. Navigate to the Microsoft Entra ID overview page in the Azure portal.

2. Select All groups from the left-hand menu.

3. On the Groups page, select New group.

4. On the New group page, fill out the following form fields:

   • Group type: Select Security.
   • Group name: Enter a name for the group that includes a reference to the app or environment name.
   • Group description: Enter a description that explains the purpose of the group.

   

5. Select the No members selected link under Members to add members to the group.

6. In the flyout panel that opens, search for the service principal you created earlier and select it from the filtered results. Choose the Select button at the bottom of the panel to confirm your selection.

7. Select Create at the bottom of the New group page to create the group and return to the All groups page. If you don't see the new group listed, wait a moment and refresh the page.

Azure CLI

1. Use the az ad group create command to create groups in Microsoft Entra ID.

   az ad group create \
       --display-name <group-name> \
       --mail-nickname <group-mail-nickname> \
       --description <group-description>
   

   The --display-name and --mail-nickname parameters are required. The name given to the group should be based on the name and environment of the app to indicate the group's purpose.

2. To add members to the group, you need the object ID of the application service principal, which is different than the application ID. Use the az ad sp list command to list the available service principals:

   az ad sp list \
       --filter "startswith(displayName, '<group-name>')" \
       --query "[].{objectId:id, displayName:displayName}"
   

   The --filter parameter accepts OData-style filters and can be used to filter the list as shown. The --query parameter limits the output to only the columns of interest.

3. Use the az ad group member add command to add members to the group:

   az ad group member add \
       --group <group-name> \
       --member-id <object-id>
   

Assign roles to the group

Next, determine what roles (permissions) your app needs on what resources and assign those roles to the Microsoft Entra group you created. Groups can be assigned a role at the resource, resource group, or subscription scope. This example shows how to assign roles at the resource group scope, since most apps group all their Azure resources into a single resource group.

Azure portal

1. In the Azure portal, navigate to the Overview page of the resource group that contains your app.

2. Select Access control (IAM) from the left navigation.

3. On the Access control (IAM) page, select + Add and then choose Add role assignment from the drop-down menu. The Add role assignment page provides several tabs to configure and assign roles.

4. On the Role tab, use the search box to locate the role you want to assign. Select the role, and then choose Next.

5. On the Members tab:

   • For the Assign access to value, select User, group, or service principal .
   • For the Members value, choose + Select members to open the Select members flyout panel.
   • Search for the Microsoft Entra group you created earlier and select it from the filtered results. Choose Select to select the group and close the flyout panel.
   • Select Review + assign at the bottom of the Members tab.

   

6. On the Review + assign tab, select Review + assign at the bottom of the page.

Azure CLI

1. Use the az role definition list command to get the names of the roles that a Microsoft Entra group or service principal can be assigned to:

   az role definition list \
       --query "sort_by([].{roleName:roleName, description:description}, &roleName)" \
       --output table
   

2. Use the az role assignment create command to assign a role to the Microsoft Entra group you created:

   az role assignment create \
       --assignee "<group-object-Id>" \
       --role "<role-name>" \
       --resource-group "<resource-group-name>"
   

   For information on assigning permissions at the resource or subscription level using the Azure CLI, see Assign Azure roles using the Azure CLI.

Sign-in to Azure using developer tooling

To authenticate with your Azure account, choose one of the following methods:

Visual Studio Code

Developers using Visual Studio Code can authenticate with their developer account directly through the editor via the broker. Apps that use DefaultAzureCredential or VisualStudioCodeCredential can then use this account to authenticate app requests through a seamless single-sign-on experience.

1. In Visual Studio Code, go to the Extensions panel and install the Azure Resources extension. This extension lets you view and manage Azure resources directly from Visual Studio Code. It also uses the built-in Visual Studio Code Microsoft authentication provider to authenticate with Azure.

   

2. Open the Command Palette in Visual Studio Code, then search for and select Azure: Sign in.

   

   Tip

   Open the Command Palette using Ctrl+Shift+P on Windows/Linux or Cmd+Shift+P on macOS.

3. Add the azure-identity-broker Python package to your app:

   pip install azure-identity-broker
   

Azure CLI

Developers can use Azure CLI to authenticate to Microsoft Entra ID. Apps using DefaultAzureCredential or AzureCliCredential can then use this account to authenticate app requests when running locally.

To authenticate with the Azure CLI, run the az login command. On a system with a default web browser, the Azure CLI launches the browser to authenticate the user.

az login

For systems without a default web browser, the az login command uses the device code authentication flow. The user can also force the Azure CLI to use the device code flow rather than launching a browser by specifying the --use-device-code argument.

az login --use-device-code

Azure Developer CLI

Developers can use Azure Developer CLI to authenticate to Microsoft Entra ID. Apps using DefaultAzureCredential or AzureDeveloperCliCredential can then use this account to authenticate app requests when running locally.

To authenticate with the Azure Developer CLI, run the azd auth login command. On a system with a default web browser, the Azure Developer CLI launches the browser to authenticate the user.

azd auth login

For systems without a default web browser, the azd auth login --use-device-code uses the device code authentication flow. The user can also force the Azure Developer CLI to use the device code flow rather than launching a browser by specifying the --use-device-code argument.

azd auth login --use-device-code

Azure PowerShell

Developers can use Azure PowerShell to authenticate to Microsoft Entra ID. Apps using DefaultAzureCredential or AzurePowerShellCredential can then use this account to authenticate app requests when running locally.

To authenticate with Azure PowerShell, run the command Connect-AzAccount. On a system with a default web browser and version 5.0.0 or later of Azure PowerShell, it launches the browser to authenticate the user.

Connect-AzAccount

For systems without a default web browser, the Connect-AzAccount command uses the device code authentication flow. The user can also force Azure PowerShell to use the device code flow rather than launching a browser by specifying the UseDeviceAuthentication argument.

Connect-AzAccount -UseDeviceAuthentication

Authenticate to Azure services from your app

The Azure Identity library provides implementations of TokenCredential that support various scenarios and Microsoft Entra authentication flows. The steps ahead demonstrate how to use DefaultAzureCredential or a specific development tool credential when working with user accounts locally.

Implement the code

1. Add the azure-identity package to your application:

   pip install azure-identity
   

   Note

   When using VisualStudioCodeCredential, you must also install the azure-identity-broker package:

   pip install azure-identity-broker
   

   Add the necessary import statements for the azure.identity module and the Azure service client module your app requires.

2. Choose one of the credential implementations based on your scenario.

   • Use a credential specific to your development tool: this option is best for single person or single tool scenarios.
   • Use a credential available for use in any development tool: this option is best for open-source projects and diverse tool teams.

Use a credential specific to your development tool

Pass a TokenCredential instance corresponding to a specific development tool to the Azure service client constructor, such as AzureCliCredential.

from azure.identity import AzureCliCredential
from azure.storage.blob import BlobServiceClient

credential = AzureCliCredential()

blob_service_client = BlobServiceClient(
   account_url="https://<account-name>.blob.core.windows.net",
   credential=credential)

Use a credential available for use in any development tool

Use a DefaultAzureCredential instance optimized for all local development tools. This example requires the environment variable AZURE_TOKEN_CREDENTIALS set to dev. For more information, see Exclude a credential type category.

from azure.identity import DefaultAzureCredential
from azure.storage.blob import BlobServiceClient

credential = DefaultAzureCredential(require_envvar=True)

blob_service_client = BlobServiceClient(
   account_url="https://<account-name>.blob.core.windows.net",
   credential=credential)

Tip

When your team uses multiple development tools to authenticate with Azure, prefer DefaultAzureCredential over tool-specific credentials.