VS Code Credential Updates (#45998)

Author: g2vinay

sdk/identity/azure-identity/TROUBLESHOOTING.md

@@ -21,6 +21,7 @@ This troubleshooting guide covers failure investigation techniques, common error
 - [Troubleshoot AzurePowerShellCredential authentication issues](#troubleshoot-azurepowershellcredential-authentication-issues)
 - [Troubleshoot WorkloadIdentityCredential authentication issues](#troubleshoot-workloadidentitycredential-authentication-issues)
 - [Troubleshoot IntelliJCredential authentication issues](#troubleshoot-intellijcredential-authentication-issues)
+- [Troubleshoot VisualStudioCodeCredential authentication issues](#troubleshoot-visualstudiocodecredential-authentication-issues)
 - [Troubleshoot AzurePipelinesCredential authentication issues](#troubleshoot-azurepipelinescredential-authentication-issues)
 - [Troubleshoot authentication timeout issues](#troubleshoot-authentication-timeout-issues)
 - [Troubleshoot Web Account Manager (WAM) brokered authentication issues](#troubleshoot-web-account-manager-wam-brokered-authentication-issues)
@@ -270,6 +271,27 @@ Get-AzAccessToken -ResourceUrl "https://management.core.windows.net"
 
 > Note: Azure Toolkit for IntelliJ version 3.53 and higher are supported by this credential. If you are using an older version, please update to the latest version.
 
+
+
+
+# Troubleshoot `VisualStudioCodeCredential` authentication issues
+
+> **Applies to:** Version 1.17.0-beta.1 and later
+
+As of version 1.17.0-beta.1, `VisualStudioCodeCredential` uses broker authentication to sign in using the Azure Resources extension in Visual Studio Code. This approach requires the `azure-identity-broker` dependency and currently only works on Windows. Broker authentication is not yet supported on macOS or Linux.
+
+#### Platform Support
+
+> **Note:** VisualStudioCodeCredential with broker authentication is currently only supported on Windows. macOS and Linux are not yet supported.
+
+#### Common Error
+
+| Error Message | Description | Mitigation |
+|---|---|---|
+| `CredentialUnavailableException: Visual Studio Code Authentication is not available. Ensure you have azure-identity-broker dependency added to your application. Then ensure, you have signed into Azure via VS Code and have Azure Resources Extension installed in VS Code.` | Broker authentication is not available, which may be due to missing dependencies, not being signed in to Azure in VS Code, or the Azure Resources extension not being installed. | <ul><li>Ensure your project includes the <code>azure-identity-broker</code> dependency.</li><li>In Visual Studio Code, install the <a href="https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureresourcegroups">Azure Resources extension</a>.</li><li>Sign in to Azure using the "Azure: Sign In" command in VS Code.</li><li>Restart your application after signing in.</li></ul> |
+
+> VisualStudioCodeCredential is intended for local development scenarios and is not recommended for production environments.
+
 ## Troubleshoot `AzurePipelinesCredential` authentication issues
 
 | Error Message |Description| Mitigation |

sdk/identity/azure-identity/src/main/java/com/azure/identity/DefaultAzureCredentialBuilder.java

@@ -334,12 +334,10 @@ private void addProdCredentials(List<TokenCredential> credentials) {
     // Helper to add dev credentials
     private void addDevCredentials(List<TokenCredential> credentials) {
         credentials.add(new IntelliJCredential(tenantId, identityClientOptions.clone()));
+        credentials.add(new VisualStudioCodeCredential(tenantId, identityClientOptions.clone()));
         credentials.add(new AzureCliCredential(tenantId, identityClientOptions.clone()));
         credentials.add(new AzurePowerShellCredential(tenantId, identityClientOptions.clone()));
         credentials.add(new AzureDeveloperCliCredential(tenantId, identityClientOptions.clone()));
-        if (IdentityUtil.isVsCodeBrokerAuthAvailable()) {
-            credentials.add(new VisualStudioCodeCredential(tenantId, identityClientOptions.clone()));
-        }
     }
 
     private WorkloadIdentityCredential getWorkloadIdentityCredential() {

sdk/identity/azure-identity/src/main/java/com/azure/identity/VisualStudioCodeCredential.java

@@ -68,7 +68,8 @@ public Mono<AccessToken> getToken(TokenRequestContext request) {
                 return Mono
                     .error(new CredentialUnavailableException("Visual Studio Code Authentication is not available."
                         + " Ensure you have azure-identity-broker dependency added to your application."
-                        + " Then ensure, you have signed into Azure via VS Code and have Azure Resources Extension installed in VS Code."));
+                        + " Then ensure, you have signed into Azure via VS Code and have Azure Resources Extension installed in VS Code."
+                        + " For more details, refer to https://aka.ms/azsdk/java/identity/vscodecredential/troubleshoot"));
             }
         }).doOnNext(token -> LoggingUtil.logTokenSuccess(LOGGER, request)).doOnError(error -> {
             LoggingUtil.logTokenError(LOGGER, clientOptions, request, error);

sdk/identity/azure-identity/src/test/java/com/azure/identity/DefaultAzureCredentialTest.java

@@ -659,13 +659,14 @@ public void testDeveloperOnlyCredentialsChain(String devValue) {
         List<TokenCredential> credentials = extractCredentials(credential);
 
         // Only developer credentials should be present (4)
-        assertEquals(4, credentials.size());
+        assertEquals(5, credentials.size());
 
         // Verify developer credentials in order
         assertInstanceOf(IntelliJCredential.class, credentials.get(0));
-        assertInstanceOf(AzureCliCredential.class, credentials.get(1));
-        assertInstanceOf(AzurePowerShellCredential.class, credentials.get(2));
-        assertInstanceOf(AzureDeveloperCliCredential.class, credentials.get(3));
+        assertInstanceOf(VisualStudioCodeCredential.class, credentials.get(1));
+        assertInstanceOf(AzureCliCredential.class, credentials.get(2));
+        assertInstanceOf(AzurePowerShellCredential.class, credentials.get(3));
+        assertInstanceOf(AzureDeveloperCliCredential.class, credentials.get(4));
     }
 
     @ParameterizedTest
@@ -772,14 +773,15 @@ public void testDefaultCredentialChainWithoutFilter() {
         List<TokenCredential> credentials = extractCredentials(credential);
 
         // Verify the complete chain with all 7 credentials
-        assertEquals(7, credentials.size());
+        assertEquals(8, credentials.size());
         assertInstanceOf(EnvironmentCredential.class, credentials.get(0));
         assertInstanceOf(WorkloadIdentityCredential.class, credentials.get(1));
         assertInstanceOf(ManagedIdentityCredential.class, credentials.get(2));
         assertInstanceOf(IntelliJCredential.class, credentials.get(3));
-        assertInstanceOf(AzureCliCredential.class, credentials.get(4));
-        assertInstanceOf(AzurePowerShellCredential.class, credentials.get(5));
-        assertInstanceOf(AzureDeveloperCliCredential.class, credentials.get(6));
+        assertInstanceOf(VisualStudioCodeCredential.class, credentials.get(4));
+        assertInstanceOf(AzureCliCredential.class, credentials.get(5));
+        assertInstanceOf(AzurePowerShellCredential.class, credentials.get(6));
+        assertInstanceOf(AzureDeveloperCliCredential.class, credentials.get(7));
     }
 
     /**