AzureDeveloperCliCredential class
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 the 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:
- Run "azd auth login" in Azure Developer CLI to authenticate interactively as a user.
- 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.
Constructors
| Azure |
Creates an instance of the AzureDeveloperCliCredential. To use this credential, ensure that you have already logged in via the 'azd' tool using the command "azd auth login" from the commandline. |
Methods
| get |
Authenticates with Microsoft Entra ID and returns an access token if successful. If authentication fails, a CredentialUnavailableError will be thrown with the details of the failure. |
Constructor Details
AzureDeveloperCliCredential(AzureDeveloperCliCredentialOptions)
Creates an instance of the AzureDeveloperCliCredential.
To use this credential, ensure that you have already logged in via the 'azd' tool using the command "azd auth login" from the commandline.
new AzureDeveloperCliCredential(options?: AzureDeveloperCliCredentialOptions)Parameters
Options, to optionally allow multi-tenant requests.
Method Details
getToken(string | string[], GetTokenOptions)
Authenticates with Microsoft Entra ID and returns an access token if successful. If authentication fails, a CredentialUnavailableError will be thrown with the details of the failure.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>Parameters
- scopes
-
string | string[]
The list of scopes for which the token will have access.
- options
- GetTokenOptions
The options used to configure any requests this TokenCredential implementation might make.
Returns
Promise<AccessToken>