[identity] Remove VSCode credential from Default Azure Credential (Azure#22851)

Author: KarishmaGhiya

sdk/identity/identity/CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Features Added
 
 ### Breaking Changes
+- Removed `VisualStudioCodeCredential` from `DefaultAzureCredential` token chain. [Issue 20500](https://github.com/Azure/azure-sdk-for-js/issues/20500) tracks this.
 
 ### Bugs Fixed
 

sdk/identity/identity/README.md

@@ -88,7 +88,7 @@ If interactive authentication cannot be supported in the session, then the `-Use
 
 #### Authenticate via Visual Studio Code
 
-Developers using Visual Studio Code can use the [Azure Account extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account) to authenticate via the editor. Apps using `DefaultAzureCredential` or `VisualStudioCodeCredential` can then use this account to authenticate calls in their app when running locally.
+Developers using Visual Studio Code can use the [Azure Account extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account) to authenticate via the editor. Apps using `VisualStudioCodeCredential` can then use this account to authenticate calls in their app when running locally.
 
 To authenticate in Visual Studio Code, ensure the Azure Account extension is installed. Once installed, open the **Command Palette** and run the **Azure: Sign In** command.
 
@@ -124,11 +124,13 @@ If used from Node.js, the `DefaultAzureCredential` will attempt to authenticate
 
 1. **Environment** - The `DefaultAzureCredential` will read account information specified via [environment variables](#environment-variables) and use it to authenticate.
 1. **Managed Identity** - If the application is deployed to an Azure host with Managed Identity enabled, the `DefaultAzureCredential` will authenticate with that account.
-1. **Visual Studio Code** - If the developer has authenticated with the [Visual Studio Code Azure Account extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account), the `DefaultAzureCredential` will authenticate using that account.
-   - In `@azure/identity` version 2.0 or later, the [`@azure/identity-vscode`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity-vscode) package must be installed for the Visual Studio Code authentication to work.
 1. **Azure CLI** - If the developer has authenticated an account via the Azure CLI `az login` command, the `DefaultAzureCredential` will authenticate with that account.
 1. **Azure PowerShell** - If the developer has authenticated using the Azure PowerShell module `Connect-AzAccount` command, the `DefaultAzureCredential` will authenticate with that account.
 
+#### Note about `VisualStudioCodeCredential`
+
+Due to a [known issue](https://github.com/Azure/azure-sdk-for-js/issues/20500), `VisualStudioCodeCredential` has been removed from the `DefaultAzureCredential` token chain. When the issue is resolved in a future release it will return.
+
 ## Plugins
 
 Azure Identity for JavaScript provides a plugin API that allows us to provide certain functionality through separate _plugin packages_. The `@azure/identity` package exports a top-level function (`useIdentityPlugin`) that can be used to enable a plugin. We provide two plugin packages:

sdk/identity/identity/images/mermaidjs/DefaultAzureCredentialAuthFlow.md

@@ -5,14 +5,14 @@
 %% 2. Run command: mmdc -i DefaultAzureCredentialAuthFlow.md -o DefaultAzureCredentialAuthFlow.svg
 
 flowchart LR;
-    A(Environment):::deployed ==> B(Managed Identity):::deployed ==> C(VS Code):::developer ==> D(Azure CLI):::developer ==> E(Azure PowerShell):::developer;
+    A(Environment):::deployed ==> B(Managed Identity):::deployed ==> D(Azure CLI):::developer ==> E(Azure PowerShell):::developer;
 
     subgraph CREDENTIAL TYPES;
         direction LR;
         Deployed(Deployed service):::deployed ==> Developer(Developer):::developer;
 
         %% Hide links between boxes in the legend by setting width to 0. The integers after "linkStyle" represent link indices.
-        linkStyle 4 stroke-width:0px;
+        linkStyle 3 stroke-width:0px;
     end;
 
     %% Define styles for credential type boxes
@@ -22,7 +22,6 @@ flowchart LR;
     %% Add API ref links to credential type boxes
     click A "https://docs.microsoft.com/javascript/api/@azure/identity/environmentcredential?view=azure-node-latest" _blank;
     click B "https://docs.microsoft.com/javascript/api/@azure/identity/managedidentitycredential?view=azure-node-latest" _blank;
-    click C "https://docs.microsoft.com/javascript/api/@azure/identity/visualstudiocodecredential?view=azure-node-latest" _blank;
     click D "https://docs.microsoft.com/javascript/api/@azure/identity/azureclicredential?view=azure-node-latest" _blank;
     click E "https://docs.microsoft.com/javascript/api/@azure/identity/azurepowershellcredential?view=azure-node-latest" _blank;
 ```

sdk/identity/identity/images/mermaidjs/DefaultAzureCredentialAuthFlow.svg

@@ -15,7 +15,6 @@ import {
   ManagedIdentityCredentialClientIdOptions,
   ManagedIdentityCredentialResourceIdOptions,
 } from "./managedIdentityCredential";
-import { VisualStudioCodeCredential } from "./visualStudioCodeCredential";
 
 /**
  * Provides options to configure the {@link DefaultAzureCredential} class.
@@ -109,7 +108,6 @@ export class DefaultManagedIdentityCredential extends ManagedIdentityCredential
 export const defaultCredentials: DefaultCredentialConstructor[] = [
   EnvironmentCredential,
   DefaultManagedIdentityCredential,
-  VisualStudioCodeCredential,
   AzureCliCredential,
   AzurePowerShellCredential,
 ];
@@ -129,17 +127,12 @@ export class DefaultAzureCredential extends ChainedTokenCredential {
    *
    * - {@link EnvironmentCredential}
    * - {@link ManagedIdentityCredential}
-   * - {@link VisualStudioCodeCredential}
    * - {@link AzureCliCredential}
    * - {@link AzurePowerShellCredential}
    *
    * Consult the documentation of these credential types for more information
    * on how they attempt authentication.
    *
-   * **Note**: `VisualStudioCodeCredential` is provided by a plugin package:
-   * `@azure/identity-vscode`. If this package is not installed and registered
-   * using the plugin API (`useIdentityPlugin`), then authentication using
-   * `VisualStudioCodeCredential` will not be available.
    * @param options - Optional parameters. See {@link DefaultAzureCredentialClientIdOptions}.
    */
   constructor(options?: DefaultAzureCredentialClientIdOptions);
@@ -154,17 +147,12 @@ export class DefaultAzureCredential extends ChainedTokenCredential {
    *
    * - {@link EnvironmentCredential}
    * - {@link ManagedIdentityCredential}
-   * - {@link VisualStudioCodeCredential}
    * - {@link AzureCliCredential}
    * - {@link AzurePowerShellCredential}
    *
    * Consult the documentation of these credential types for more information
    * on how they attempt authentication.
    *
-   * **Note**: `VisualStudioCodeCredential` is provided by a plugin package:
-   * `@azure/identity-vscode`. If this package is not installed and registered
-   * using the plugin API (`useIdentityPlugin`), then authentication using
-   * `VisualStudioCodeCredential` will not be available.
    * @param options - Optional parameters. See {@link DefaultAzureCredentialResourceIdOptions}.
    */
   constructor(options?: DefaultAzureCredentialResourceIdOptions);
@@ -179,18 +167,12 @@ export class DefaultAzureCredential extends ChainedTokenCredential {
    *
    * - {@link EnvironmentCredential}
    * - {@link ManagedIdentityCredential}
-   * - {@link VisualStudioCodeCredential}
    * - {@link AzureCliCredential}
    * - {@link AzurePowerShellCredential}
    *
    * Consult the documentation of these credential types for more information
    * on how they attempt authentication.
    *
-   * **Note**: `VisualStudioCodeCredential` is provided by a plugin package:
-   * `@azure/identity-vscode`. If this package is not installed and registered
-   * using the plugin API (`useIdentityPlugin`), then authentication using
-   * `VisualStudioCodeCredential` will not be available.
-   *
    * @param options - Optional parameters. See {@link DefaultAzureCredentialOptions}.
    */
   constructor(options?: DefaultAzureCredentialOptions);

sdk/identity/identity/src/credentials/defaultAzureCredential.ts

@@ -188,6 +188,7 @@ export class VisualStudioCodeCredential implements TokenCredential {
           "You must install the identity-vscode plugin package (`npm install --save-dev @azure/identity-vscode`)",
           "and enable it by importing `useIdentityPlugin` from `@azure/identity` and calling",
           "`useIdentityPlugin(vsCodePlugin)` before creating a `VisualStudioCodeCredential`.",
+          "To troubleshoot, visit https://aka.ms/azsdk/js/identity/vscodecredential/troubleshoot.",
         ].join(" ")
       );
     }