This troubleshooting guide covers failure investigation techniques, common errors for the credential types in the Azure Identity library for .NET, and mitigation steps to resolve these errors.
- Handle Azure Identity exceptions
- Find relevant information in exception messages
- Enable and configure logging
- Troubleshoot DefaultAzureCredential authentication issues
- Troubleshoot EnvironmentCredential authentication issues
- Troubleshoot ClientSecretCredential authentication issues
- Troubleshoot ClientCertificateCredential authentication issues
- Troubleshoot ClientAssertionCredential authentication issues
- Troubleshoot WorkloadIdentityCredential authentication issues
- Troubleshoot ManagedIdentityCredential authentication issues
- Troubleshoot VisualStudioCredential authentication issues
- Troubleshoot VisualStudioCodeCredential authentication issues
- Troubleshoot AzureDeveloperCliCredential authentication issues
- Troubleshoot AzureCliCredential authentication issues
- Troubleshoot AzurePowerShellCredential authentication issues
- Troubleshoot multi-tenant authentication issues
- Troubleshoot brokered authentication issues
- Troubleshoot AzurePipelinesCredential authentication issues
- Get additional help
Exceptions arising from authentication errors can be raised on any service client method that makes a request to the service. This is because the token is requested from the credential on:
- The first call to the service.
- Any subsequent requests to the service that need to refresh the token.
To distinguish these failures from failures in the service client, Azure Identity classes raise the AuthenticationFailedException with details describing the source of the error in the exception message and possibly the error message. Depending on the application, these errors may or may not be recoverable.
using Azure.Identity;
using Azure.Security.KeyVault.Secrets;
// Create a secret client using the DefaultAzureCredential
var client = new SecretClient(new Uri("https://myvault.vault.azure.net/"), new DefaultAzureCredential());
try
{
KeyVaultSecret secret = await client.GetSecretAsync("secret1");
}
catch (AuthenticationFailedException e)
{
Console.WriteLine($"Authentication Failed. {e.Message}");
}The CredentialUnavailableException is a special exception type derived from AuthenticationFailedException. This exception type is used to indicate that the credential can't authenticate in the current environment, due to lack of required configuration or setup. This exception is also used as a signal to chained credential types, such as DefaultAzureCredential and ChainedTokenCredential, that the chained credential should continue to try other credential types later in the chain.
Calls to service clients resulting in RequestFailedException with a StatusCode of 401 or 403 often indicate the caller doesn't have sufficient permissions for the specified API. Check the service documentation to determine which RBAC roles are needed for the specific request, and ensure the authenticated user or service principal have been granted the appropriate roles on the resource.
AuthenticationFailedException is thrown when unexpected errors occurred while a credential is authenticating. This can include errors received from requests to the Microsoft Entra STS and often contains information helpful to diagnosis. Consider the following AuthenticationFailedException message.
This error contains several pieces of information:
-
Failing Credential Type: The type of credential that failed to authenticate. This can be helpful when diagnosing issues with chained credential types such as
DefaultAzureCredentialorChainedTokenCredential. -
STS Error Code and Message: The error code and message returned from the Microsoft Entra STS. This can give insight into the specific reason the request failed. For instance, in this specific case because the provided client secret is incorrect. More information on STS error codes can be found here.
-
Correlation ID and Timestamp: The correlation ID and call Timestamp used to identify the request in server-side logs. This information can be useful to support engineers when diagnosing unexpected STS failures.
The Azure Identity library provides the same logging capabilities as the rest of the Azure SDK.
The simplest way to see the logs to help debug authentication issues is to enable the console logger.
// Set up a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();All credentials can be configured with diagnostic options, in the same way as other clients in the SDK.
DefaultAzureCredentialOptions options = new
{
Diagnostics =
{
LoggedHeaderNames = { "x-ms-request-id" },
LoggedQueryParameters = { "api-version" },
IsLoggingContentEnabled = true
}
};CAUTION: Requests and responses in the Azure Identity library contain sensitive information. Precaution must be taken to protect logs when customizing the output to avoid compromising account security.
When troubleshooting authentication issues, you may also want to enable logging of sensitive information. To enable this type of logging, set the IsLoggingContentEnabled property to true. To only log details about the account that was used to attempt authentication and authorization, set the IsAccountIdentifierLoggingEnabled property to true:
DefaultAzureCredentialOptions options = new
{
Diagnostics =
{
LoggedHeaderNames = { "x-ms-request-id" },
LoggedQueryParameters = { "api-version" },
IsAccountIdentifierLoggingEnabled = true
}
};CredentialUnavailableException
| Error Message | Description | Mitigation |
|---|---|---|
| Environment variables aren't fully configured. | A valid combination of environment variables wasn't set. | Ensure the appropriate environment variables are set prior to application startup for the intended authentication method.
|
| Password protection for PEM encoded certificates is not supported. | AZURE_CLIENT_CERTIFICATE_PASSWORD was set when using a PEM encoded certificate. |
Re-encode the client certificate to a password protected PFX (PKCS12) certificate, or a PEM certificate without password protection. |
AuthenticationFailedException
| Error Code | Issue | Mitigation |
|---|---|---|
| AADSTS7000215 | An invalid client secret was provided. | Ensure the clientSecret provided when constructing the credential is valid. If unsure, create a new client secret using the Azure portal. Details on creating a new client secret can be found here. |
| AADSTS7000222 | An expired client secret was provided. | Create a new client secret using the Azure portal. Details on creating a new client secret can be found here. |
| AADSTS700016 | The specified application wasn't found in the specified tenant. | Ensure the specified clientId and tenantId are correct for your application registration. For multi-tenant apps, ensure the application has been added to the desired tenant by a tenant admin. To add a new application in the desired tenant, follow the instructions here. |
AuthenticationFailedException
| Error Code | Description | Mitigation |
|---|---|---|
| AADSTS700027 | Client assertion contains an invalid signature. | Ensure the specified certificate has been uploaded to the Microsoft Entra application registration. Instructions for uploading certificates to the application registration can be found here. |
| AADSTS700016 | The specified application wasn't found in the specified tenant. | Ensure the specified clientId and tenantId are correct for your application registration. For multi-tenant apps, ensure the application has been added to the desired tenant by a tenant admin. To add a new application in the desired tenant, follow the instructions here. |
AuthenticationFailedException
| Error Code | Description | Mitigation |
|---|---|---|
| AADSTS700021 | Client assertion application identifier doesn't match 'client_id' parameter. Review the documentation at Microsoft Identity platform application authentication certificate credentials. | Ensure the JWT assertion created has the correct values specified for the sub and issuer value of the payload, both of these should have the value be equal to clientId. Refer to the documentation for client assertion format. |
| AADSTS700023 | Client assertion audience claim doesn't match Realm issuer. Review the documentation at Microsoft Identity platform application authentication certificate credentials. | Ensure the audience aud field in the JWT assertion created has the correct value for the audience specified in the payload. This should be set to https://login.microsoftonline.com/{tenantId}/v2. |
| AADSTS50027 | JWT token is invalid or malformed. | Ensure the JWT assertion token is in the valid format. Refer to the documentation for client assertion format. |
CredentialUnavailableException
| Error Message | Description | Mitigation |
|---|---|---|
CredentialUnavailableException raised with message. "WorkloadIdentityCredential authentication unavailable. The workload options are not fully configured." |
The WorkloadIdentityCredential requires ClientId, TenantId and TokenFilePath to authenticate with Microsoft Entra ID. |
|
| The workload options are not fully configured. | The workload identity configuration wasn't provided in environment variables or through WorkloadIdentityCredentialOptions. |
Ensure the appropriate environment variables are set prior to application startup or are specified in code.
|
AuthenticationFailedException for applications using Azure Kubernetes Service identity bindings
| Error Message | Description | Mitigation |
|---|---|---|
|
WorkloadIdentityCredential isn't configured to use the identity binding proxy. |
When using WorkloadIdentityCredential directly, set WorkloadIdentityCredentialOptions.IsAzureProxyEnabled to true. Identity binding mode isn't supported when WorkloadIdentityCredential is used via DefaultAzureCredential, so construct and use a WorkloadIdentityCredential explicitly to enable this option. |
The ManagedIdentityCredential is designed to work on various Azure hosts that provide managed identity. Configuring the managed identity and troubleshooting failures varies from hosts. The following table lists the Azure hosts that can be assigned a managed identity and are supported by the ManagedIdentityCredential.
| Host Environment | ||
|---|---|---|
| Azure App Service and Azure Functions | Configuration | Troubleshooting |
| Azure Arc | Configuration | |
| Azure Service Fabric | Configuration | |
| Azure Virtual Machines and Scale Sets | Configuration | Troubleshooting |
CredentialUnavailableException
| Error Message | Description | Mitigation |
|---|---|---|
| The requested identity hasn't been assigned to this resource. | The IMDS endpoint responded with a status code of 400, indicating the requested identity isn't assigned to the VM. | If using a user assigned identity, ensure the specified clientId is correct.If using a system assigned identity, make sure it has been enabled properly. Instructions to enable the system assigned identity on an Azure VM can be found here. |
| The request failed due to a gateway error. | The request to the IMDS endpoint failed due to a gateway error, 502 or 504 status code. | IMDS doesn't support calls via proxy or gateway. Disable proxies or gateways running on the VM for calls to the IMDS endpoint http://169.254.169.254/ |
| No response received from the managed identity endpoint. | No response was received for the request to IMDS or the request timed out. |
|
| Multiple attempts failed to obtain a token from the managed identity endpoint. | Retries to retrieve a token from the IMDS endpoint have been exhausted. |
|
If you have access to the VM, you can verify the managed identity endpoint is available via the command line using curl.
curl 'http://169.254.169.254/metadata/identity/oauth2/token?resource=https://management.core.windows.net&api-version=2018-02-01' -H "Metadata: true"Note that output of this command will contain a valid access token, and SHOULD NOT BE SHARED to avoid compromising account security.
CredentialUnavailableException
| Error Message | Description | Mitigation |
|---|---|---|
| ManagedIdentityCredential authentication unavailable. | The environment variables configured by the App Services host weren't present. |
|
If you have access to SSH into the App Service, you can verify managed identity is available in the environment. First ensure the environment variables MSI_ENDPOINT and MSI_SECRET have been set in the environment. Then you can verify the managed identity endpoint is available using curl.
curl 'http://169.254.169.254/metadata/identity/oauth2/token?resource=https://management.core.windows.net&api-version=2018-02-01' -H "Metadata: true"Note that the output of this command will contain a valid access token, and SHOULD NOT BE SHARED to avoid compromising account security.
CredentialUnavailableException
| Error Message | Description | Mitigation |
|---|---|---|
| Failed To Read CredentialsORAuthenticate via Azure Service Authentication | The VisualStudioCredential failed to retrieve a token from the Visual Studio authentication utility Microsoft.Asal.TokenService.exe. |
|
| ADFS tenant not supported | ADFS tenants aren't currently supported by Visual Studio Azure Service Authentication. |
Use credentials from a supported cloud when authenticating with Visual Studio. The supported clouds are:
|
| AADSTS65001: The user or administrator has not consented to use the application with ID '04f0c124-f2bc-4f59-8241-bf6df9866bbd' named 'Visual Studio'. | The user needs to add Visual Studio as an authorized application to their Azure resource. | Follow the instructions at Pre-authorize your client application. |
| AADSTS65002: Consent between first party application '04f0c124-f2bc-4f59-8241-bf6df9866bbd' and first party resource '' must be configured via preauthorization - applications owned and operated by Microsoft must get approval from the API owner before requesting tokens for that API. | The client application used by Visual Studio is not yet pre-authorized for the Azure resource mentioned in the error. | Follow the instructions under the Pre-authorization issues section of this document. |
CredentialUnavailableException
| Error Message | Description | Mitigation |
|---|---|---|
| VisualStudioCodeCredential requires the Azure.Identity.Broker package to be installed. | Brokered authentication is unavailable, which may be due to missing dependencies, not being signed in to Azure in VS Code, or the Azure Resources extension not being installed. |
|
CredentialUnavailableException
| Error Message | Description | Mitigation |
|---|---|---|
| Azure CLI not installed | The Azure CLI isn't installed or couldn't be found. |
|
| Please run 'az login' to set up account | No account is currently logged into the Azure CLI, or the login has expired. |
|
You can manually verify that the Azure CLI is properly authenticated and can obtain tokens. First, use the account command to verify the account that is currently logged in to the Azure CLI.
az account showOnce you've verified the Azure CLI is using the correct account, you can validate that it's able to obtain tokens for this account.
az account get-access-token --output json --resource https://management.core.windows.netNote that output of this command will contain a valid access token, and SHOULD NOT BE SHARED to avoid compromising account security.
CredentialUnavailableException
| Error Message | Description | Mitigation |
|---|---|---|
| Azure Developer CLI not installed | The Azure Developer CLI isn't installed or couldn't be found. |
|
| Please run 'azd auth login' to set up account | No account is currently logged into the Azure Developer CLI, or the login has expired. |
|
You can manually verify that the Azure Developer CLI is properly authenticated and can obtain tokens. Execute the command corresponding to your CLI version to verify the account currently logged in.
-
In Azure Developer CLI versions >= 1.23.0:
azd auth status
-
In Azure Developer CLI versions < 1.23.0:
azd config list
Once you've verified the Azure Developer CLI is using correct account, you can validate that it's able to obtain tokens for this account.
azd auth token --output json --scope https://management.core.windows.net/.defaultNote that output of this command will contain a valid access token, and SHOULD NOT BE SHARED to avoid compromising account security.
CredentialUnavailableException
| Error Message | Description | Mitigation |
|---|---|---|
| PowerShell isn't installed. | No local installation of PowerShell was found. | Ensure that PowerShell is properly installed on the machine. Instructions for installing PowerShell can be found here. |
| Az.Account module >= 2.2.0 isn't installed. | The Az.Account module needed for authentication in Azure PowerShell isn't installed. | Install the latest Az.Account module. Installation instructions can be found here. |
| Please run 'Connect-AzAccount' to set up account. | No account is currently logged into Azure PowerShell. |
|
You can manually verify that Azure PowerShell is properly authenticated, and can obtain tokens. First, use the Get-AzContext command to verify the account that is currently logged in to the Azure CLI.
PS C:\> Get-AzContext
Name Account SubscriptionName Environment TenantId
---- ------- ---------------- ----------- --------
Subscription1 (xxxxxxxx-xxxx-xxxx-xxx... test@outlook.com Subscription1 AzureCloud xxxxxxxx-x...
Once you've verified Azure PowerShell is using correct account, validate that it's able to obtain tokens for this account:
Get-AzAccessToken -ResourceUrl "https://management.core.windows.net"Note that output of this command will contain a valid access token, and SHOULD NOT BE SHARED to avoid compromising account security.
AuthenticationFailedException
| Error Message | Description | Mitigation |
|---|---|---|
| The current credential is not configured to acquire tokens for tenant <tenant ID>. | The app must configure the credential to allow token acquisition from the requested tenant. | Make one of the following changes in the credential's options:
This exception was added as part of a breaking change to multi-tenant authentication in version |
TypeLoadException for IMsalSettablePublicClientInitializerOptions or IMsalPublicClientInitializerOptions after updating Azure.Identity
If you see the following error after updating to Azure.Identity 1.21.0+ or Azure.Core 1.53.0+:
TypeLoadException: Could not load type 'Azure.Identity.IMsalSettablePublicClientInitializerOptions'
from assembly 'Azure.Identity, Version=1.21.0.0, Culture=neutral, PublicKeyToken=92742159e12e44c8'.
Or if brokered authentication fails (e.g., DefaultAzureCredential can no longer use WAM, or connections using Authentication=ActiveDirectoryDefault fail), you need to update Azure.Identity.Broker to version 1.6.0 or later.
Older Azure.Identity.Broker versions (1.5.0 and earlier) reference internal types that moved from Azure.Identity to Azure.Core as part of the type consolidation. Update your package reference:
<PackageReference Include="Azure.Identity.Broker" Version="1.6.0" />See the migration guide for more details.
| Error Message | Description | Mitigation |
|---|---|---|
| AADSTS50011 | The application is missing the expected redirect URI. | Ensure that one of redirect URIs registered for the Microsoft Entra application matches the following URI pattern: ms-appx-web://Microsoft.AAD.BrokerPlugin/{client_id} |
When using InteractiveBrowserCredential, by default, only the Microsoft Entra account is listed:
If you choose "Use another account" and type in an MSA outlook.com account, it fails:
Since version 1.0.0-beta.4 of Azure.Identity.Broker, you can set the IsLegacyMsaPassthroughEnabled property on InteractiveBrowserCredentialBrokerOptions or SharedTokenCacheCredentialBrokerOptions to true. MSA outlook.com accounts that are logged in to Windows are automatically listed:
You may also log in another MSA account by selecting "Microsoft account":
| Error Message | Description | Mitigation |
|---|---|---|
| 0xffffffffffff5bf0 - Application's teamId is missing, and redirectUri is not matching unsigned format | For console applications using the broker on macOS, the following RedirectUri should be set: msauth.com.msauth.unsignedapp://auth |
Additional information on ways to reach out for support can be found in the SUPPORT.md at the root of the repo.