This troubleshooting guide covers failure investigation techniques, common errors for the credential types in the azidentity module, and mitigation steps to resolve these errors.
- Handle azidentity errors
- Find relevant information in errors
- Enable and configure logging
- Troubleshoot AzureCLICredential authentication issues
- Troubleshoot AzureDeveloperCLICredential authentication issues
- Troubleshoot ClientCertificateCredential authentication issues
- Troubleshoot ClientSecretCredential authentication issues
- Troubleshoot DefaultAzureCredential authentication issues
- Troubleshoot EnvironmentCredential authentication issues
- Troubleshoot ManagedIdentityCredential authentication issues
- Troubleshoot UsernamePasswordCredential authentication issues
- Troubleshoot WorkloadIdentityCredential authentication issues
- Get additional help
Any service client method that makes a request to the service may return an error due to authentication failure. This is because the credential authenticates on the first call to the service and on any subsequent call that needs to refresh an access token. Authentication errors include a description of the failure and possibly an error message from Microsoft Entra ID. Depending on the application, these errors may or may not be recoverable.
Service client errors with a status code of 401 or 403 often indicate that authentication succeeded but the caller doesn't have permission to access the specified API. Check the service documentation to determine which RBAC roles are needed for the request, and ensure the authenticated user or service principal has the appropriate role assignments.
Authentication errors can include responses from Microsoft Entra ID and often contain information helpful in diagnosis. Consider the following error message:
ClientSecretCredential authentication failed
POST https://login.microsoftonline.com/3c631bb7-a9f7-4343-a5ba-a615913/oauth2/v2.0/token
--------------------------------------------------------------------------------
RESPONSE 401 Unauthorized
--------------------------------------------------------------------------------
{
"error": "invalid_client",
"error_description": "AADSTS7000215: Invalid client secret provided. Ensure the secret being sent in the request is the client secret value, not the client secret ID, for a secret added to app '86be4c01-505b-45e9-bfc0-9b825fd84'.\r\nTrace ID: 03da4b8e-5ffe-48ca-9754-aff4276f0100\r\nCorrelation ID: 7b12f9bb-2eef-42e3-ad75-eee69ec9088d\r\nTimestamp: 2022-03-02 18:25:26Z",
"error_codes": [
7000215
],
"timestamp": "2022-03-02 18:25:26Z",
"trace_id": "03da4b8e-5ffe-48ca-9754-aff4276f0100",
"correlation_id": "7b12f9bb-2eef-42e3-ad75-eee69ec9088d",
"error_uri": "https://login.microsoftonline.com/error?code=7000215"
}
--------------------------------------------------------------------------------
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. -
Microsoft Entra ID Error Code and Message: The error code and message returned by Microsoft Entra ID. This can give insight into the specific reason the request failed. For instance, in this case authentication failed because the provided client secret is incorrect. Microsoft Entra ID documentation has more information on AADSTS error codes.
-
Correlation ID and Timestamp: The correlation ID and timestamp identify the request in server-side logs. This information can be useful to support engineers diagnosing unexpected Microsoft Entra failures.
azidentity 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 print credential logs to the console.
import azlog "github.com/Azure/azure-sdk-for-go/sdk/azcore/log"
// print log output to stdout
azlog.SetListener(func(event azlog.Event, s string) {
fmt.Println(s)
})
// include only azidentity credential logs
azlog.SetEvents(azidentity.EventAuthentication)| Error | Description | Mitigation |
|---|---|---|
| "DefaultAzureCredential failed to acquire a token" | No credential in the DefaultAzureCredential chain provided a token |
|
| Error from the client with a status code of 401 or 403 | Authentication succeeded but the authorizing Azure service responded with a 401 (Unauthorized), or 403 (Forbidden) status code |
|
| "managed identity timed out" | DefaultAzureCredential sets a short timeout on its first managed identity authentication attempt to prevent very long timeouts during local development when no managed identity is available. That timeout causes this error in production when an application requests a token before the hosting environment is ready to provide one. |
Use ManagedIdentityCredential directly, at least in production. It doesn't set a timeout on its authentication attempts. |
| Error Message | Description | Mitigation |
|---|---|---|
| Missing or incomplete environment variable configuration | A valid combination of environment variables wasn't set | Ensure the appropriate environment variables are set for the intended authentication method as described in the module documentation |
| Error Code | Issue | Mitigation |
|---|---|---|
| AADSTS7000215 | An invalid client secret was provided. | Ensure the secret provided to the credential constructor is valid. If unsure, create a new client secret using the Azure portal. Details on creating a new client secret are in Microsoft Entra ID documentation. |
| AADSTS7000222 | An expired client secret was provided. | Create a new client secret using the Azure portal. Details on creating a new client secret are in Microsoft Entra ID documentation. |
| AADSTS700016 | The specified application wasn't found in the specified tenant. | Ensure the client and tenant IDs provided to the credential constructor 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 Microsoft Entra ID instructions. |
| Error Code | Description | Mitigation |
|---|---|---|
| AADSTS700027 | Client assertion contains an invalid signature. | Ensure the specified certificate has been uploaded to the application registration as described in Microsoft Entra ID documentation. |
| AADSTS700016 | The specified application wasn't found in the specified tenant. | Ensure the client and tenant IDs provided to the credential constructor 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 Microsoft Entra ID instructions. |
| Error Code | Issue | Mitigation |
|---|---|---|
| AADSTS50126 | The provided username or password is invalid. | Ensure the username and password provided to the credential constructor are valid. |
ManagedIdentityCredential is designed to work on a variety of Azure hosts support managed identity. Configuration and troubleshooting vary from host to host. The below table lists the Azure hosts that can be assigned a managed identity and are supported by ManagedIdentityCredential.
| Host Environment | ||
|---|---|---|
| Azure Virtual Machines and Scale Sets | Configuration | Troubleshooting |
| Azure App Service and Azure Functions | Configuration | Troubleshooting |
| Azure Kubernetes Service | Configuration | Troubleshooting |
| Azure Arc | Configuration | |
| Azure Service Fabric | Configuration |
| 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 ID is correct. If using a system assigned identity, make sure it has been enabled as described in managed identity documentation. |
| 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 requests via proxy or gateway. Disable proxies or gateways running on the VM for requests 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. | The credential has exhausted its retries for a token request. |
|
If you have access to the VM, you can use curl to verify the managed identity endpoint is available.
curl 'http://169.254.169.254/metadata/identity/oauth2/token?resource=https://management.core.windows.net&api-version=2018-02-01' -H "Metadata: true"This command's output will contain an access token and SHOULD NOT BE SHARED, to avoid compromising account security.
| Error Message | Description | Mitigation |
|---|---|---|
Get "http://169.254.169.254/..." i/o timeout |
The App Service host hasn't set environment variables for managed identity configuration. |
|
If you can SSH into the App Service, you can verify managed identity is available in the environment. First ensure the environment variables IDENTITY_ENDPOINT and IDENTITY_SECRET are set. Then you can verify the managed identity endpoint is available using curl.
curl "$IDENTITY_ENDPOINT?resource=https://management.core.windows.net&api-version=2019-08-01" -H "X-IDENTITY-HEADER: $IDENTITY_HEADER"This command's output will contain an access token and SHOULD NOT BE SHARED, to avoid compromising account security.
| Error Message | Description | Mitigation |
|---|---|---|
| "no azure identity found for request clientID" | The application attempted to authenticate before an identity was assigned to its pod | Verify the pod is labeled correctly. This also occurs when a correctly labeled pod authenticates before the identity is ready. To prevent initialization races, configure NMI to set the Retry-After header in its responses as described in Pod Identity documentation. |
| Error Message | Description | Mitigation |
|---|---|---|
| Azure CLI not found on path | The Azure CLI isn’t installed or isn't on the application's path. |
|
| 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 can authenticate and obtain tokens. First, use the account command to verify the logged in account.
az account show
Once you've verified the Azure CLI is using the correct account, you can validate that it's able to obtain tokens for that account.
az account get-access-token --output json --resource https://management.core.windows.net
This command's output will contain an access token and SHOULD NOT BE SHARED, to avoid compromising account security.
| Error Message | Description | Mitigation |
|---|---|---|
| Azure Developer CLI not found on path | The Azure Developer CLI isn't installed or couldn't be found. |
|
| Please run "azd auth login" | No account is 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. First, use the config command to verify the account that is currently logged in to the Azure Developer CLI.
azd config listOnce 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.
| Error Message | Description | Mitigation |
|---|---|---|
| no client ID/tenant ID/token file specified | Incomplete configuration | In most cases these values are provided via environment variables set by Azure Workload Identity.
|
Additional information on ways to reach out for support can be found in SUPPORT.md.