auth: Add a getSessionWithScopes to AzureAuthentication (#1762)

* Add a getSessionWithScopes to AzureAuthentication * Remove scopes as a parameter * Bump package version * Fix build and PR feedback * Actually listen to PR feedback
microsoft · Aug 6, 2024 · bbd9dbf · bbd9dbf
1 parent f35ccad
commit bbd9dbf
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 19 deletions.
diff --git a/auth/package-lock.json b/auth/package-lock.json
diff --git a/auth/package.json b/auth/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@microsoft/vscode-azext-azureauth",
     "author": "Microsoft Corporation",
-    "version": "2.4.1",
+    "version": "2.5.0",
     "description": "Azure authentication helpers for Visual Studio Code",
     "tags": [
         "azure",

diff --git a/auth/src/AzureAuthentication.ts b/auth/src/AzureAuthentication.ts
@@ -9,12 +9,19 @@ import type * as vscode from 'vscode';
  * Represents a means of obtaining authentication data for an Azure subscription.
  */
 export interface AzureAuthentication {
+    /**
+     * Gets a VS Code authentication session for an Azure subscription.
+     * Always uses the default scope, `https://management.azure.com/.default/` and respects `microsoft-sovereign-cloud.environment` setting.
+     *
+     * @returns A VS Code authentication session or undefined, if none could be obtained.
+     */
+    getSession(): vscode.ProviderResult<vscode.AuthenticationSession>;
     /**
      * Gets a VS Code authentication session for an Azure subscription.
      *
      * @param scopes - The scopes for which the authentication is needed.
      *
      * @returns A VS Code authentication session or undefined, if none could be obtained.
      */
-    getSession(scopes?: string[]): vscode.ProviderResult<vscode.AuthenticationSession>;
+    getSessionWithScopes(scopes: string[]): vscode.ProviderResult<vscode.AuthenticationSession>;
 }
diff --git a/auth/src/AzureDevOpsSubscriptionProvider.ts b/auth/src/AzureDevOpsSubscriptionProvider.ts
@@ -152,25 +152,26 @@ export class AzureDevOpsSubscriptionProvider implements AzureSubscriptionProvide
         }
 
         const accessToken = (await this._tokenCredential?.getToken("https://management.azure.com/.default"))?.token || '';
+        const getSession = () => {
+            return {
+                accessToken,
+                id: this._tokenCredential?.tenantId || '',
+                account: {
+                    id: this._tokenCredential?.tenantId || '',
+                    label: this._tokenCredential?.tenantId || '',
+                },
+                tenantId: this._tokenCredential?.tenantId || '',
+                scopes: scopes || [],
+            };
+        };
         return {
             client: new armSubs.SubscriptionClient(this._tokenCredential,),
             credential: this._tokenCredential,
             authentication: {
-                getSession: (_scopes: string[] | undefined) => {
-                    return {
-                        accessToken,
-                        id: this._tokenCredential?.tenantId || '',
-                        account: {
-                            id: this._tokenCredential?.tenantId || '',
-                            label: this._tokenCredential?.tenantId || '',
-                        },
-                        tenantId: this._tokenCredential?.tenantId || '',
-                        scopes: scopes || [],
-                    };
-
-                }
+                getSession,
+                getSessionWithScopes: getSession,
             }
-        };
+        }
     }
 
     public onDidSignIn: Event<void> = () => { return new Disposable(() => { /*empty*/ }) };

diff --git a/auth/src/VSCodeAzureSubscriptionProvider.ts b/auth/src/VSCodeAzureSubscriptionProvider.ts
@@ -260,7 +260,10 @@ export class VSCodeAzureSubscriptionProvider extends vscode.Disposable implement
             client: new armSubs.SubscriptionClient(credential, { endpoint }),
             credential: credential,
             authentication: {
-                getSession: () => session
+                getSession: () => session,
+                getSessionWithScopes: (scopes) => {
+                    return getSessionFromVSCode(scopes, tenantId, { createIfNone: false, silent: true })
+                },
             }
         };
     }