Dela via

AzureDeveloperCliCredential Class

  • Reference
Package:
com.azure.identity
Maven Artifact:
com.azure:azure-identity:1.14.2
  • java.lang.Object
    • com.azure.identity.AzureDeveloperCliCredential

Implements

TokenCredential

public class AzureDeveloperCliCredential
implements TokenCredential

Azure Developer CLI is a command-line interface tool that allows developers to create, manage, and deploy resources in Azure. It's built on top of the Azure CLI and provides additional functionality specific to Azure developers. It allows users to authenticate as a user and/or a service principal against Microsoft Entra ID. The AzureDeveloperCliCredential authenticates in a development environment and acquires a token on behalf of the logged-in user or service principal in Azure Developer CLI. It acts as the Azure Developer CLI logged in user or service principal and executes an Azure CLI command underneath to authenticate the application against Microsoft Entra ID.

Configure AzureDeveloperCliCredential

To use this credential, the developer needs to authenticate locally in Azure Developer CLI using one of the commands below:

  1. Run "azd auth login" in Azure Developer CLI to authenticate interactively as a user.
  2. Run "azd auth login --client-id clientID --client-secret clientSecret --tenant-id tenantID" to authenticate as a service principal.

You may need to repeat this process after a certain time period, depending on the refresh token validity in your organization. Generally, the refresh token validity period is a few weeks to a few months. AzureDeveloperCliCredential will prompt you to sign in again.

Sample: Construct AzureDeveloperCliCredential

The following code sample demonstrates the creation of a AzureDeveloperCliCredential, using the AzureDeveloperCliCredentialBuilder to configure it. Once this credential is created, it may be passed into the builder of many of the Azure SDK for Java client builders as the 'credential' parameter.

TokenCredential azureDevCliCredential = new AzureDeveloperCliCredentialBuilder().build();

Method Summary

Modifier and Type Method and Description
Mono<AccessToken> getToken(TokenRequestContext request)
AccessToken getTokenSync(TokenRequestContext request)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

getToken

public Mono getToken(TokenRequestContext request)

Parameters:

request

getTokenSync

public AccessToken getTokenSync(TokenRequestContext request)

Parameters:

request

Applies to